From 94b0983c7a6bfdbe9de7a4226adcde379049fded Mon Sep 17 00:00:00 2001 From: github-actions Date: Thu, 14 Dec 2023 22:26:20 +0000 Subject: [PATCH] Update to 1 in STEP and README.md --- .github/steps/-step.txt | 2 +- README.md | 83 +++++++++++++++++++++++------------------ 2 files changed, 47 insertions(+), 38 deletions(-) diff --git a/.github/steps/-step.txt b/.github/steps/-step.txt index 573541a..d00491f 100644 --- a/.github/steps/-step.txt +++ b/.github/steps/-step.txt @@ -1 +1 @@ -0 +1 diff --git a/README.md b/README.md index 5df74cc..295cacf 100644 --- a/README.md +++ b/README.md @@ -16,54 +16,63 @@ _Create a release based workflow that is built on the foundations of the GitHub -## Welcome +## Step 1: Create a beta release -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. +_Welcome to "Release-based workflow" :sparkle:_ -GitHub releases allow your team to package and provide software to your users based on a specific point in the history of your project. +### The GitHub flow -- **Who is this for**: Developers, DevOps Engineers, IT Operations, managers, and teams. -- **What you'll learn**: How to follow a release-based workflow. -- **What you'll build**: You will create tags, releases, and release notes. -- **Prerequisites**: If you need to learn about branches, commits, and pull requests, take [Introduction to GitHub](https://github.com/skills/introduction-to-github) first. -- **How long**: This course takes less than 1 hour to complete. +The [GitHub flow](https://guides.github.com/introduction/flow/) is a lightweight, branch-based workflow for projects with regular deployments. -In this course, you will: +![github-flow](https://user-images.githubusercontent.com/6351798/48032310-63842400-e114-11e8-8db0-06dc0504dcb5.png) -1. Create a beta release -2. Add a feature to a release -3. Open a release pull request -4. Add release notes and merge -5. Finalize a release -6. Commit a hotfix -7. Create a hotfix release +Some projects may deploy more often, with continuous deployment. There might be a "release" every time there's a new commit on main. -### How to start this course +But, some projects rely on a different structure for versions and releases. - +### Versions + +Versions are different iterations of updated software like operating systems, apps, or dependencies. Common examples are "Windows 8.1" to "Windows 10", or "macOS High Sierra" to "macOS Mojave". + +Developers update code and then run tests on the project for bugs. During that time, the developers might set up certain securities to protect from new code or bugs. Then, the tested code is ready for production. Teams version the code and release it for installation by end users. + +### :keyboard: Activity: Create a release for the current codebase + +In this step, you will create a release for this repository on GitHub. + +GitHub Releases point to a specific commit. Releases can include release notes in Markdown files, and attached binaries. + +Before using a release based workflow for a larger release, let's create a tag and a release. + +1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab. +1. Go to the **Releases** page for this repository. + - _Tip: To reach this page, click the **Code** tab at the top of your repository. Then, find the navigation bar below the repository description, and click the **Releases** heading link._ +1. Click **Create a new release**. +1. In the field for _Tag version_, specify a number. In this case, use **v0.9**. Keep the _Target_ as **main**. +1. Give the release a title, like "First beta release". If you'd like, you could also give the release a short description. +1. Select the checkbox next to **Set as a pre-release**, since it is representing a beta version. +1. Click **Publish release**. + +### :keyboard: Activity: Introduce a bug to be fixed later -[![start-course](https://user-images.githubusercontent.com/1221423/235727646-4a590299-ffe5-480d-8cd5-8194ea184546.svg)](https://github.com/new?template_owner=skills&template_name=release-based-workflow&owner=%40me&name=skills-release-based-workflow&description=My+clone+repository&visibility=public) +To set the stage for later, let's also add a bug that we'll fix as part of the release workflow in later steps. We've already created a `update-text-colors` branch for you so let's create and merge a pull request with this branch. -1. Right-click **Start course** and open the link in a new tab. -2. In the new tab, most of the prompts will automatically fill in for you. - - For owner, choose your personal account or an organization to host the repository. - - We recommend creating a public repository, as private repositories will [use Actions minutes](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions). - - Scroll down and click the **Create repository** button at the bottom of the form. -3. After your new repository is created, wait about 20 seconds, then refresh the page. Follow the step-by-step instructions in the new repository's README. +1. Open a **new pull request** with `base: release-v1.0` and `compare: update-text-colors`. +1. Set the pull request title to "Updated game text style". You can include a detailed pull request body, an example is below: + ``` + ## Description: + - Updated game text color to green + ``` +1. Click **Create pull request**. +1. We'll merge this pull request now. Click **Merge pull request** and delete your branch. +1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step.