Skip to content

Commit

Permalink
Formatting updates for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
heiskr committed May 31, 2023
1 parent 761e622 commit 1062d75
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 12 deletions.
8 changes: 7 additions & 1 deletion .github/steps/1-create-beta-release.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
<!--Step 1-->
<!--
<<< Author notes: Step 1 >>>
Choose 3-5 steps for your course.
The first step is always the hardest, so pick something easy!
Link to docs.github.com for further explanations.
Encourage users to open new tabs for steps!
-->

## Step 1: Create a beta release

Expand Down
6 changes: 5 additions & 1 deletion .github/steps/2-feature-added-to-release.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!--Step 2-->
<!--
<<< Author notes: Step 2 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
-->

## Step 2: Add a new feature to the release branch

Expand Down
6 changes: 5 additions & 1 deletion .github/steps/3-release-pr-opened.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!--Step 3-->
<!--
<<< Author notes: Step 3 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
-->

## Step 3: Open a release pull request

Expand Down
6 changes: 5 additions & 1 deletion .github/steps/4-release-notes-and-merge.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!--Step 4-->
<!--
<<< Author notes: Step 4 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
-->

## Step 4: Generate release notes and merge

Expand Down
6 changes: 5 additions & 1 deletion .github/steps/5-finalize-release.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!--Step 5-->
<!--
<<< Author notes: Step 5 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
-->

## Step 5: Finalize the release

Expand Down
6 changes: 5 additions & 1 deletion .github/steps/6-commit-hotfix.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!--Step 6-->
<!--
<<< Author notes: Step 6 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
-->

## Step 6: Commit a hotfix to the release

Expand Down
6 changes: 5 additions & 1 deletion .github/steps/7-create-hotfix-release.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<!--Step 7-->
<!--
<<< Author notes: Step 7 >>>
Start this step by acknowledging the previous step.
Define terms and link to docs.github.com.
-->

## Step 7: Create release v1.0.1

Expand Down
5 changes: 5 additions & 0 deletions .github/steps/X-finish.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
<!--
<<< Author notes: Finish >>>
Review what we learned, ask for feedback, provide next steps.
-->

## Finish

<img src="https://octodex.github.com/images/snowtocat_final.jpg" alt=celebrate width=300 align=right>
Expand Down
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
<header>

<!--
The step and endstep markers will cause this
introduction content to be hidden once the
repository is created off the template
<<< Author notes: Course header >>>
Read <https://skills.github.com/quickstart> for more information about how to build courses using this template.
Include a 1280×640 image, course name in sentence case, and a concise description in emphasis.
In your repository settings: enable template repository, add your 1280×640 social image, auto delete head branches.
Next to "About", add description & tags; disable releases, packages, & environments.
Add your open source license, GitHub uses the MIT license.
-->

# Create a release based workflow
Expand All @@ -12,6 +15,12 @@ _Create a release based workflow that is built on the foundations of the GitHub

</header>

<!--
<<< Author notes: Course start >>>
Include start button, a note about Actions minutes,
and tell the learner why they should take the course.
-->

## Welcome

Create a release based workflow that is built on the foundations of the [GitHub flow](https://guides.github.com/introduction/flow/). When your team uses a release-based workflow, GitHub makes it easy to collaborate with deployable iterations of your project that you can package and make available for a wider audience to download and use.
Expand Down Expand Up @@ -58,10 +67,15 @@ In this course, you will:

<footer>

<!--
<<< Author notes: Footer >>>
Add a link to get support, GitHub status page, code of conduct, license link.
-->

---

Get help: [Post in our discussion board](https://github.com/skills/.github/discussions) [Review the GitHub status page](https://www.githubstatus.com/)
Get help: [Post in our discussion board](https://github.com/skills/.github/discussions) &bull; [Review the GitHub status page](https://www.githubstatus.com/)

© 2022 GitHub [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) [MIT License](https://gh.io/mit)
&copy; 2023 GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)

</footer>

0 comments on commit 1062d75

Please sign in to comment.