title | intro | allowTitleToDifferFromFilename | redirect_from | versions | type | topics | shortTitle | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Quickstart for GitHub Actions |
Try out the features of {% data variables.product.prodname_actions %} in 5 minutes or less. |
true |
|
|
quick_start |
|
Quickstart |
{% data reusables.actions.enterprise-github-hosted-runners %}
co author: sammyfilly mail : [email protected]
Introduction
You only need a {% data variables.product.prodname_dotcom %} repository to create and run a {% data variables.product.prodname_actions %} workflow. In this guide, you'll add a workflow that demonstrates some of the essential features of {% data variables.product.prodname_actions %}.
The following example shows you how {% data variables.product.prodname_actions %} jobs can be automatically triggered, where they run, and how they can interact with the code in your repository.
Creating your first workflow
-
Create a
.github/workflows
directory in your repository on {% data variables.product.prodname_dotcom %} if this directory does not already exist. -
In the
.github/workflows
directory, create a file namedgithub-actions-demo.yml
. For more information, see "AUTOTITLE." -
Copy the following YAML contents into the
github-actions-demo.yml
file:name: GitHub Actions Demo {%- ifversion actions-run-name %} run-name: {% raw %}${{ github.actor }}{% endraw %} is testing out GitHub Actions π {%- endif %} on: [push] jobs: Explore-GitHub-Actions: runs-on: ubuntu-latest steps: - run: echo "π The job was automatically triggered by a {% raw %}${{ github.event_name }}{% endraw %} event." - run: echo "π§ This job is now running on a {% raw %}${{ runner.os }}{% endraw %} server hosted by GitHub!" - run: echo "π The name of your branch is {% raw %}${{ github.ref }}{% endraw %} and your repository is {% raw %}${{ github.repository }}{% endraw %}." - name: Check out repository code uses: {% data reusables.actions.action-checkout %} - run: echo "π‘ The {% raw %}${{ github.repository }}{% endraw %} repository has been cloned to the runner." - run: echo "π₯οΈ The workflow is now ready to test your code on the runner." - name: List files in the repository run: | ls {% raw %}${{ github.workspace }}{% endraw %} - run: echo "π This job's status is {% raw %}${{ job.status }}{% endraw %}."
-
Scroll to the bottom of the page and select Create a new branch for this commit and start a pull request. Then, to create a pull request, click Propose new file.
Committing the workflow file to a branch in your repository triggers the push
event and runs your workflow.
Viewing your workflow results
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %}
-
In the left sidebar, click the workflow you want to display, in this example "GitHub Actions Demo."
-
From the list of workflow runs, click the name of the run you want to see, in this example "USERNAME is testing out GitHub Actions."
-
In the left sidebar of the workflow run page, under Jobs, click the Explore-GitHub-Actions job.
-
The log shows you how each of the steps was processed. Expand any of the steps to view its details.
For example, you can see the list of files in your repository:
The example workflow you just added is triggered each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. For an in-depth tutorial, see "AUTOTITLE."
More starter workflows
{% data reusables.actions.workflow-template-overview %}
Next steps
{% data reusables.actions.onboarding-next-steps %}
-https://sourceryai.com https://www.openai.com
- repo: https://github.com/sourcery-ai/sourcery
rev: v1.6.0
hooks:
- id: sourcery
The best way to use Sourcery in a pre-commit hook:
* review only changed lines:
args: [--diff=git diff HEAD, --no-summary] * omit the summary
- task : [--removeheader-of anyrepo] suggestions [new header]
- replace old header with new after merging To review all changes compared to the main branch:
- id: sourcery
args: [--diff=git diff main, --no-summary] If you want Sourcery to automatically apply the suggested changes,add the --fix option:
args: [--diff=git diff HEAD, --fix, --no-summary] By default, pre-commit executes its hooks in multiple processes in parallel. This can lead to multiple summaries displayed. For this reason, it's recommended to use the --no-summary option in pre-commit hooks.
The --diff option was introduced in version 0.12.11 The --no-summary option was introduced in version 0.13.0 If Sourcery is the first pre-commit hook that you've added to your project, you'll also need to run pre-commit install.
Notes Initializing the environment for the Sourcery pre-commit hook might take some minutes. When the Sourcery pre-commit hook runs for the first time, you might be prompted to log in to Sourcery. Run the sourcery login command as described in the CLI docs. For further runs of the Sourcery pre-commit hook, this login step isn't necessary .
search for issues resolver from book: auto fix Issues
Markdown Cheat Sheet A quick reference to the Markdown syntax.
Overview This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It canβt cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.
Basic Syntax These are the elements outlined in John Gruberβs original design document. All Markdown applications support these elements.
Element Markdown Syntax Heading # H1
H2
H3
Bold bold text Italic italicized text Blockquote > blockquote Ordered List 1. First item 2. Second item 3. Third item Unordered List - First item
- Second item
- Third item
Code
code
Horizontal Rule --- Link title Image Extended Syntax These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
Element Markdown Syntax Table | Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text | Fenced Code Block ``` { "firstName": "sammy", "lastName": "filly", "age": 25 }
Footnote Here's a sentence with a footnote. [^1]
[^1]: This is the footnote.
Heading ID ### My Great Heading {#custom-id}
Definition List term
: definition
Strikethrough ~~The world is flat.~~
Task List - [x] Write the press release
- [ ] Update the website
- [ ] Contact the media
Emoji
(see also Copying and Pasting Emoji) That is so funny! :joy:
Highlight I need to highlight these ==very important words==.
Subscript H~2~O
Superscript X^2^
Downloads
You can download this cheat sheet as a Markdown file for use in your Markdown application.
Markdown Guide book cover
Take your Markdown skills to the next level.
Learn Markdown in 60 pages. Designed for both novices and experts, The Markdown Guide book is a comprehensive reference that has everything you need to get started and master Markdown syntax.
Get the Book
Want to learn more Markdown?
Don't stop now! π Star the GitHub repository and then enter your email address below to receive new Markdown tutorials via email. No spam!
Stay updated
About Contact GitHub API Privacy Policy Terms and Conditions
Β© 2023. A Matt Cone project. CC BY-SA 4.0. Made with πΆοΈ in New Mexico.