├── .github └── workflows │ └── ci-link-checker.yml ├── CODEOWNERS ├── CONTRIBUTING.md ├── LICENSE └── README.md /.github/workflows/ci-link-checker.yml: -------------------------------------------------------------------------------- 1 | name: Links-Checker 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | branches: [main] 7 | paths: 8 | - 'README.md' 9 | - '.github/workflows/ci-link-checker.yml' 10 | 11 | jobs: 12 | linkChecker: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v4 16 | 17 | - name: Link Checker 18 | id: lychee 19 | uses: lycheeverse/lychee-action@v1.9.3 20 | -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @tungbq 2 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | The following information provides a set of guidelines for contributing to the **tungbq/awesome-workflow** chain main repo. Use your best judgment, and, if you see room for improvement, please propose changes to this document. 4 | 5 | ## First steps 6 | 7 | The first step is to find an issue you want to fix. To identify issues we think are good for first-time contributors, we add the **good first issue** label. 8 | Once you find an existing issue that you want to work on or if you have a new issue to create, continue below. 9 | 10 | ## Proposing changes 11 | 12 | To contribute a change proposal, use the following workflow: 13 | 14 | 1. [Fork the repository](https://github.com/tungbq/awesome-workflow). 15 | 2. If you find this repository helpful, kindly consider showing your appreciation by giving it a star ⭐ Thanks! 💖 16 | 3. [Add an upstream](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) so that you can update your fork. 17 | 4. Clone your fork to your computer. 18 | 5. Create a branch and name it appropriately. 19 | 6. Work on only one major change in one pull request. 20 | 7. Make sure all tests are passing locally. 21 | 8. Next, rinse and repeat the following: 22 | 23 | 1. Commit your changes. Write a simple, straightforward commit message. To learn more, see [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/). 24 | 2. Push your changes to your remote fork. To add your remote, you can copy/paste the following: 25 | 26 | ```sh 27 | 28 | #Remove origin 29 | 30 | git remote remove origin 31 | 32 | #set a new remote 33 | 34 | git remote add my_awesome_new_remote_repo [insert-link-found-in-source-subtab-of-your-repo] 35 | 36 | #Verify new remote 37 | 38 | git remote -v 39 | 40 | > my_awesome_new_remote_repo [link-found-in-source-subtab-of-your-repo] (fetch) 41 | > my_awesome_new_remote_repo [link-found-in-source-subtab-of-your-repo] (push) 42 | 43 | #Push changes to your remote repo 44 | 45 | git push 46 | 47 | #e.g. git push my_awesome_new_remote_repo 48 | ``` 49 | 50 | 3. Create a PR on the **awesome-workflow** repository. There should be a PR template to help you do so. 51 | 4. Wait for your changes to be reviewed. If you are a maintainer, you can assign your PR to one or more reviewers. If you aren't a maintainer, one of the maintainers will assign a reviewer. 52 | 5. After you receive feedback from a reviewer, make the requested changes, commit them to your branch, and push them to your remote fork again. 53 | 6. Once approval is given, feel free to squash & merge! 54 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Awesome Workflow [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) 2 | 3 | :octocat: Awesome lists about GitHub workflows to automate your development workflow 🥰 4 | 5 | ## Quickstart for GitHub Actions 6 | 7 | If you are new to GitHub Actions workflows, the following documentation could help you get started: 8 | 9 | - [actions/quickstart](https://docs.github.com/en/actions/quickstart) 10 | - [actions/learn-github-actions](https://docs.github.com/en/actions/learn-github-actions) 11 | 12 | ## Official Starter Workflow by GitHub 13 | 14 | - [actions/starter-workflows](https://github.com/actions/starter-workflows) 15 | 16 | ## Top Github Action Workflows 1️⃣ 17 | 18 | - [Most installed/starred actrions on Marketplace 🌟](https://github.com/marketplace?category=&type=actions&verification=&query=updated%3A%3E2021-01-01+sort%3Apopularity-desc) 19 | 20 | ## Context 21 | - [github-context](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context) 22 | 23 | ## Reference GitHub Actions Workflows Repository 24 | 25 | Explore how popular open-source repositories implement GitHub Action workflows 26 | 27 | | ID | Workflow | Area | 28 | | :-- | :---------------------------------------------------------------------------------------------------------- | :----------------------------------------------------- | 29 | | 01 | [microservices-demo](https://github.com/GoogleCloudPlatform/microservices-demo/tree/main/.github/workflows) | `microservices`, `k8s`, `docker`, `helm` | 30 | | 02 | [apache/superset](https://github.com/apache/superset/tree/master/.github/workflows) | `js`, `python`, `k8s`, `docker`, `aws`, `release` | 31 | | 03 | [aws/aws-cdk](https://github.com/aws/aws-cdk/tree/main/.github/workflows) | `label`, `lint`, `auto-approve`, `python`, `js` | 32 | | 04 | [tensorflow/tensorflow](https://github.com/tensorflow/tensorflow/tree/master/.github/workflows) | `c++`, `python`, `docker`, `cd` | 33 | | 05 | [docker/compose](https://github.com/docker/compose/tree/main/.github/workflows) | `golang`, `docker`, `codecov`, `release`, `cache` | 34 | | 06 | [grafana/loki](https://github.com/grafana/loki/tree/main/.github/workflows) | `golang`, `helm`, `labeler`, `release`, `security` | 35 | | 07 | [helm/helm](https://github.com/helm/helm/tree/main/.github/workflows) | `golang`, `codeql`, `helm`, `stale`, `release` | 36 | | 08 | [hashicorp/vault](https://github.com/hashicorp/vault/tree/main/.github/workflows) | `golang`, `security`, `labeler`, `changelog`, `nodejs` | 37 | | 09 | [actions/runner](https://github.com/actions/runner/tree/main/.github/workflows) | `bot`, `codeql`, `multi-os`, `linter`, `stale` | 38 | | 10 | [vercel/next.js](https://github.com/vercel/next.js/tree/canary/.github/workflows) | `js`, `deploy`, `rust`, `testing`, `multi-os` | 39 | | 11 | [curl/curl](https://github.com/curl/curl/tree/master/.github/workflows) | `linux`, `c`, `badwords`, `multi-os` | 40 | | 12 | [devops-toolkit](https://github.com/tungbq/devops-toolkit/tree/main/.github/workflows) | `docker`, `release`, `labeler`, `dockerfile-linter` | 41 | 42 | And more upcoming content...⏩ you can follow this repository to get more up-to-dated content ⭐ 43 | 44 | ## Contributing 45 | 46 | - See: [CONTRIBUTING.md](./CONTRIBUTING.md) 47 | - Looking for the issue to work on? Check the list of our open issues [**good first issue**](https://github.com/tungbq/awesome-workflow/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 48 | - Feel free to open a new issue if you want to request more content about GitHub Action workflow 49 | --------------------------------------------------------------------------------