Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

chore: update readme when a new release is available #548

Merged
merged 13 commits into from
Nov 28, 2024

Conversation

dsotirakis
Copy link
Contributor

@dsotirakis dsotirakis commented Nov 27, 2024

We need this feature so the README.md guide always contains the latest version of the action.

Currently our workflow READMEs are a bit misleading since we tell people to use main, which will cause backwards compatibility issues.

Working example.

@dsotirakis dsotirakis self-assigned this Nov 27, 2024
@dsotirakis dsotirakis force-pushed the update-readme-before-releasing-new-version branch from e13bf3e to f957c24 Compare November 27, 2024 10:05
@dsotirakis dsotirakis force-pushed the update-readme-before-releasing-new-version branch from 3123d83 to 2eec1f6 Compare November 28, 2024 10:50
@dsotirakis dsotirakis changed the title chore: update readme when a new action release happens chore: update readme when a new release is available Nov 28, 2024
@dsotirakis dsotirakis marked this pull request as ready for review November 28, 2024 10:53
@dsotirakis dsotirakis requested review from a team as code owners November 28, 2024 10:53
@dsotirakis dsotirakis linked an issue Nov 28, 2024 that may be closed by this pull request
Copy link
Member

@iainlane iainlane left a comment

Choose a reason for hiding this comment

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

Cool, looks like a good change 👍

Can we have a linter which ensures this file stays correct? Otherwise people (like me) will forget. 😢

README.md Outdated Show resolved Hide resolved
@dsotirakis
Copy link
Contributor Author

dsotirakis commented Nov 28, 2024

Can we have a linter which ensures this file stays correct? Otherwise people (like me) will forget. 😢

Yeah, I want to create a new PR with the remaining actions and then create that lint rule if that's okay?

Assuming you're talking about the config file 🙃

@iainlane
Copy link
Member

Can we have a linter which ensures this file stays correct? Otherwise people (like me) will forget. 😢

Yeah, I want to create a new PR with the remaining actions and then create that lint rule if that's okay?

OK if you want to do it that way, that's fine

@dsotirakis dsotirakis requested a review from iainlane November 28, 2024 12:06
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
release-please-config.json Outdated Show resolved Hide resolved
@dsotirakis dsotirakis requested a review from iainlane November 28, 2024 13:22
Copy link
Member

@iainlane iainlane left a comment

Choose a reason for hiding this comment

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

hell yeah

@dsotirakis dsotirakis added this pull request to the merge queue Nov 28, 2024
Merged via the queue into main with commit 9bf9163 Nov 28, 2024
15 checks passed
@dsotirakis dsotirakis deleted the update-readme-before-releasing-new-version branch November 28, 2024 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tag and release all actions
2 participants