Skip to content

docs: include versioning details and migration guides in the readme#410

Merged
zimeg merged 3 commits into
mainfrom
docs-migration-guide
Mar 14, 2025
Merged

docs: include versioning details and migration guides in the readme#410
zimeg merged 3 commits into
mainfrom
docs-migration-guide

Conversation

@zimeg

@zimeg zimeg commented Mar 12, 2025

Copy link
Copy Markdown
Member

Summary

This PR adds a migration guide to the README and a "table of contents" to find fast links between section headers 👾 ✨

Following #398!

Preview

🔗 https://github.com/slackapi/slack-github-action/tree/docs-migration-guide

Requirements

@zimeg zimeg added the docs Improvements or additions to documentation label Mar 12, 2025
@zimeg zimeg self-assigned this Mar 12, 2025
@codecov

codecov Bot commented Mar 12, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (f841ea5) to head (aecc23f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #410   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files           7        7           
  Lines         702      702           
=======================================
  Hits          701      701           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@zimeg zimeg linked an issue Mar 12, 2025 that may be closed by this pull request

@WilliamBergamin WilliamBergamin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 🚀 great job!!

@zimeg

zimeg commented Mar 14, 2025

Copy link
Copy Markdown
Member Author

@WilliamBergamin Thanks a ton! But all credit to @thejeff77 for suggesting that this info be included in the README.md 👾

I'll go ahead with a merge now, but I'm so open to revisiting how or even where this information is organized later 📚 ✨

@zimeg zimeg merged commit a1646ab into main Mar 14, 2025
@zimeg zimeg deleted the docs-migration-guide branch March 14, 2025 22:24
@thejeff77

thejeff77 commented Mar 15, 2025

Copy link
Copy Markdown

Thanks folks!

I have some additional tidbits to share, unfortunately with a lot of the inputs moving to the payload, actionlint is much less helpful in verifying if the action is still valid after migration. Requires a lot of trial and error.

It would be pretty cool if chatGPT or Copilot could be trained up on migrations to make this a bit more automated. I'm sure it will get there at some point anyway.

Hints on checking validity locally without having to commit, push, run would be welcome! (If they exist)

@zimeg zimeg added this to the 2.x milestone Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Migration is messy - request for better documentation and advice

3 participants