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

Update README to include required actions/checkout@main in workflow example #154

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

frankiebordone
Copy link

Description of the Change

This PR addresses an issue in the README's example workflow files where it was unclear that the actions/checkout@main step is required for the GitHub Action to function properly during the deployment process.

Closes #109

Changelog Entry

Added - Documentation update in the README with required actions/checkout@main step for clarity in example workflow

Credits

Props @frankiebordone

Checklist:

@frankiebordone frankiebordone self-assigned this Oct 10, 2024
@frankiebordone frankiebordone requested a review from a team as a code owner October 10, 2024 15:17
@jeffpaul jeffpaul added this to the 2.3.0 milestone Oct 10, 2024
@jeffpaul jeffpaul requested review from faisal-alvi and removed request for a team and jeffpaul October 16, 2024 00:51
faisal-alvi
faisal-alvi previously approved these changes Oct 18, 2024
Copy link
Member

@faisal-alvi faisal-alvi left a comment

Choose a reason for hiding this comment

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

We should also replace the actions/checkout@master with actions/checkout@main in the repository.

@helen
Copy link
Collaborator

helen commented Oct 21, 2024

Should probably pin to a specific version, like actions/checkout@v4

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.

README Example should indicate actions/checkout@master is required
4 participants