Skip to content

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

New issue

Have a question about this project? Sign up for a free account to open an issue and contact its maintainers and the community.

By clicking β€œSign up for ”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on ? Sign in to your account

Merged
merged 3 commits into from
Mar 14, 2025

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Mar 12, 2025

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://.com/slackapi/slack--action/tree/docs-migration-guide

Requirements

@zimegzimeg added the docsImprovements or additions to documentationlabel Mar 12, 2025
@zimegzimeg self-assigned this Mar 12, 2025
@codecovCodecov
Copy link

codecov bot commented Mar 12, 2025β€’

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.

@zimegzimeg linked an issue Mar 12, 2025that may be closed by this pull request
Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

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

Nice πŸš€ great job!!

@zimeg
Copy link
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 πŸ“š ✨

@zimegzimeg merged commit a1646ab into main Mar 14, 2025
7 checks passed
@zimegzimeg deleted the docs-migration-guide branch March 14, 2025 22:24
@thejeff77
Copy link

thejeff77 commented Mar 15, 2025β€’

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)

@zimegzimeg added this to the 2.x milestone Mar 26, 2025
Sign up for free to join this conversation on . Already have an account? Sign in to comment
Labels
docsImprovements 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