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

Add GitHub Actions tips to readme.md #378

Merged
merged 5 commits into from
May 7, 2021
Merged

Conversation

mickelsonmichael
Copy link
Contributor

Please see #368 for the full breakdown of this addition. Due to issues with a fork, that PR needed to be recreated to be properly updated.

The updates to the original PR include minor adjustments to the URL when defining the step and some minor formatting improvements, as well as the addition of a section describing how to use named scripts inside the Action(s).

The tip should lay out how to correctly configure a step to deploy an application via Github Actions. See issue tschaub#345 for more details
The hard-coded repository name can be replaced with the use
of the GITHUB_REPOSITORY environmental variable available
to the runner by default. The GitHub Actions tip has been
updated to reflect this feature.
When executing the gh-pages command via a script
defined inside the packages.json file, it requires
the addition of an `--` parameter to properly pass
the user information into the `gh-pages` command.
A new example has been added reflecting that advice.

This commit also includes minor formatting fixes and
improvements the the existing GitHub Actions example.
Add GitHub Action tip for both named and unnamed commands
@CDeLeon94
Copy link

Thank you for f67964d
real new to this whole CICD thing and that tip helped me get my action working.

@tschaub tschaub merged commit b69b4d3 into tschaub:main May 7, 2021
@tschaub
Copy link
Owner

tschaub commented May 7, 2021

Thanks for the contribution, @mickelsonmichael!

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.

4 participants