pax_global_header 0000666 0000000 0000000 00000000064 14403121471 0014507 g ustar 00root root 0000000 0000000 52 comment=b75f96efec81b5dcd24649784a6eab7959920958
workflows.common-1.0.2/ 0000775 0000000 0000000 00000000000 14403121471 0015033 5 ustar 00root root 0000000 0000000 workflows.common-1.0.2/.github/ 0000775 0000000 0000000 00000000000 14403121471 0016373 5 ustar 00root root 0000000 0000000 workflows.common-1.0.2/.github/dependabot.yml 0000664 0000000 0000000 00000000670 14403121471 0021226 0 ustar 00root root 0000000 0000000 # To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
workflows.common-1.0.2/.github/release-drafter.yml 0000664 0000000 0000000 00000000140 14403121471 0022156 0 ustar 00root root 0000000 0000000 template: |
## What’s Changed
$CHANGES
exclude-labels:
- "skip-changelog"
- "invalid"
workflows.common-1.0.2/.github/version-drafter.yml 0000664 0000000 0000000 00000000231 14403121471 0022224 0 ustar 00root root 0000000 0000000 major-labels: [ 'semver:major', 'Breaking Change' ]
minor-labels: [ 'semver:minor','enhancement', 'Deprecation' ]
patch-labels: [ 'semver:patch','bug' ]
workflows.common-1.0.2/.github/workflows/ 0000775 0000000 0000000 00000000000 14403121471 0020430 5 ustar 00root root 0000000 0000000 workflows.common-1.0.2/.github/workflows/calculate-next-version.yml 0000664 0000000 0000000 00000001335 14403121471 0025551 0 ustar 00root root 0000000 0000000 name: Calculate Next Version
on:
workflow_call:
outputs:
version:
description: "The next version formatted to use with release-drafter"
value: ${{ format('{0}', jobs.calculate_next_version.outputs.version) }}
version-unformatted:
description: "The next version"
value: ${{ jobs.calculate_next_version.outputs.version }}
jobs:
calculate_next_version:
name: Calculate next release version
runs-on: ubuntu-latest
outputs:
version: ${{ steps.version.outputs.next-version }}
steps:
- name: Run version drafter
id: version
uses: patrickjahns/version-drafter-action@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
workflows.common-1.0.2/.github/workflows/draft-release.yml 0000664 0000000 0000000 00000001053 14403121471 0023670 0 ustar 00root root 0000000 0000000 name: Draft Release
on:
workflow_call:
inputs:
version:
description: 'The version formatted for release-drafter to use'
required: true
type: string
jobs:
draft_release:
name: Create draft release
runs-on: ubuntu-latest
steps:
- name: Run release drafter
uses: release-drafter/release-drafter@v5
with:
version: ${{ inputs.version }}
tag: ${{ inputs.version }}
name: ${{ inputs.version }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
workflows.common-1.0.2/.github/workflows/self_prepareRelease.yml 0000664 0000000 0000000 00000001315 14403121471 0025123 0 ustar 00root root 0000000 0000000 name: Prepare Release
on:
push:
branches: [ release ]
paths-ignore:
- '**.md'
jobs:
calculate_next_version:
uses: codenamephp/workflows.common/.github/workflows/calculate-next-version.yml@release
draft_release:
needs: calculate_next_version
uses: codenamephp/workflows.common/.github/workflows/draft-release.yml@release
with:
version: ${{ needs.calculate_next_version.outputs.version }}
update_changelog:
uses: codenamephp/workflows.common/.github/workflows/update-changelog.yml@release
needs: calculate_next_version
with:
ref: ${{github.ref_name}}
future-release: ${{ needs.calculate_next_version.outputs.version }}
release-branch: 'release' workflows.common-1.0.2/.github/workflows/self_updateReleaseVersions.yml 0000664 0000000 0000000 00000000506 14403121471 0026501 0 ustar 00root root 0000000 0000000 name: Update Release Versions
on:
release:
types:
- published
jobs:
update_release_versions:
uses: codenamephp/workflows.common/.github/workflows/updateReleaseVersions.yml@release
with:
version: ${{ github.event.release.tag_name }}
release_ref: ${{ github.event.release.target_commitish }}
workflows.common-1.0.2/.github/workflows/update-changelog.yml 0000664 0000000 0000000 00000002453 14403121471 0024366 0 ustar 00root root 0000000 0000000 name: Update Changelog
on:
workflow_call:
inputs:
ref:
description: 'The branch ref to work on.'
required: true
type: string
exclude-labels:
description: 'Labels of issues and PRs that should be excluded from the changelog.'
default: 'duplicate,question,invalid,wontfix,skip-changelog'
type: string
future-release:
description: 'The version of the future release instead of "unreleased" section'
default: ''
type: string
release-branch:
description: 'The branch to limit the PRs to'
default: ''
type: string
jobs:
update_changelog:
name: Update changelog
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
ref: ${{inputs.ref}}
- name: create changelog
uses: charmixer/auto-changelog-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
exclude_labels: ${{inputs.exclude-labels}}
future_release: ${{inputs.future-release}}
release_branch: ${{inputs.release-branch}}
- name: commit updated changelog
uses: EndBug/add-and-commit@v9
with:
message: "[CHANGELOG] Updated changelog"
add: "CHANGELOG.md"
workflows.common-1.0.2/.github/workflows/updateReleaseVersions.yml 0000664 0000000 0000000 00000002437 14403121471 0025475 0 ustar 00root root 0000000 0000000 name: Update Release Versions
on:
workflow_call:
inputs:
version:
description: "The version that was just released (semver compliant)"
required: true
type: string
release_ref:
description: "The ref the release versions should point to"
required: true
type: string
jobs:
parse_version:
name: Parse Version
runs-on: ubuntu-latest
outputs:
major: ${{ steps.parse.outputs.major }}
minor: ${{ steps.parse.outputs.minor }}
patch: ${{ steps.parse.outputs.patch }}
steps:
- name: Parse version
id: parse
run: |
echo "major=$(echo ${{ inputs.version }} | cut -d '.' -f 1)" >> $GITHUB_OUTPUT
echo "minor=$(echo ${{ inputs.version }} | cut -d '.' -f 2)" >> $GITHUB_OUTPUT
echo "patch=$(echo ${{ inputs.version }} | cut -d '.' -f 3)" >> $GITHUB_OUTPUT
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Update tags
run: |
MAJOR="${{ steps.parse.outputs.major }}"
MINOR="${{ steps.parse.outputs.major }}.${{ steps.parse.outputs.major }}"
TARGET="${{ inputs.release_ref }}"
git tag -f $MAJOR $TARGET
git tag -f $MINOR $TARGET
git push origin $MAJOR $MINOR --force workflows.common-1.0.2/.idea/ 0000775 0000000 0000000 00000000000 14403121471 0016013 5 ustar 00root root 0000000 0000000 workflows.common-1.0.2/.idea/.gitignore 0000664 0000000 0000000 00000000260 14403121471 0020001 0 ustar 00root root 0000000 0000000 # Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml
workflows.common-1.0.2/.idea/jsonSchemas.xml 0000664 0000000 0000000 00000002145 14403121471 0021014 0 ustar 00root root 0000000 0000000
workflows.common-1.0.2/.idea/misc.xml 0000664 0000000 0000000 00000000426 14403121471 0017472 0 ustar 00root root 0000000 0000000
workflows.common-1.0.2/.idea/modules.xml 0000664 0000000 0000000 00000000434 14403121471 0020206 0 ustar 00root root 0000000 0000000
workflows.common-1.0.2/.idea/php.xml 0000664 0000000 0000000 00000001105 14403121471 0017321 0 ustar 00root root 0000000 0000000
workflows.common-1.0.2/.idea/vcs.xml 0000664 0000000 0000000 00000000247 14403121471 0017333 0 ustar 00root root 0000000 0000000
workflows.common-1.0.2/.idea/workflows.common.iml 0000664 0000000 0000000 00000000431 14403121471 0022040 0 ustar 00root root 0000000 0000000
workflows.common-1.0.2/CHANGELOG.md 0000664 0000000 0000000 00000002405 14403121471 0016645 0 ustar 00root root 0000000 0000000 # Changelog
## [1.0.1](https://github.com/codenamephp/workflows.common/tree/1.0.1) (2023-03-11)
[Full Changelog](https://github.com/codenamephp/workflows.common/compare/1.0.0...1.0.1)
## [1.0.0](https://github.com/codenamephp/workflows.common/tree/1.0.0) (2023-03-11)
[Full Changelog](https://github.com/codenamephp/workflows.common/compare/d93eeaab08ca03dc1dea324d964051b7872b7c9f...1.0.0)
**Closed issues:**
- set-output is deprecated [\#5](https://github.com/codenamephp/workflows.common/issues/5)
**Merged pull requests:**
- Initial Release [\#6](https://github.com/codenamephp/workflows.common/pull/6) ([bastianschwarz](https://github.com/bastianschwarz))
- Update update-changelog.yml [\#4](https://github.com/codenamephp/workflows.common/pull/4) ([bastianschwarz](https://github.com/bastianschwarz))
- Bump EndBug/add-and-commit from 8 to 9 [\#2](https://github.com/codenamephp/workflows.common/pull/2) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump actions/checkout from 2 to 3 [\#1](https://github.com/codenamephp/workflows.common/pull/1) ([dependabot[bot]](https://github.com/apps/dependabot))
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
workflows.common-1.0.2/LICENSE 0000664 0000000 0000000 00000026135 14403121471 0016047 0 ustar 00root root 0000000 0000000 Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
workflows.common-1.0.2/README.md 0000664 0000000 0000000 00000007266 14403121471 0016325 0 ustar 00root root 0000000 0000000 # workflows.common
Contains common workflows like updating changelogs etc.
NOTE: All examples use @release. You should pin this to a major semver version.
Also have a look at the parameters of the workflows in their files. They are documented there. No need to duplicate it here.
All workflows that are prefixed with self_ are workflows that are for this repo only like release management and cannot be called.
## Workflows
### Calculate Version
This workflow calculates the version based on the latest tag and the current branch. It then sets the
version as an output which can be used in other workflows.
```yaml
name: Prepare Release
on:
push:
branches: [ release ]
paths-ignore:
- '**.md'
jobs:
calculate_next_version:
uses: codenamephp/workflows.common/.github/workflows/calculate-next-version.yml@relase
update_changelog:
uses: codenamephp/workflows.common/.github/workflows/update-changelog.yml@release
needs: calculate_next_version
with:
ref: ${{github.ref_name}}
future-release: ${{ needs.calculate_next_version.outputs.version }}
release-branch: 'release'
```
### Update Changelog
This workflow updates the changelog file with the latest changes. This works when all your features are
developed in a feature branch and merged using a pull request.
```yaml
name: Update Changelog
on:
push:
branches: [ main ]
paths-ignore:
- "**.md"
jobs:
update_changelog:
uses: codenamephp/workflows.common/.github/workflows/update-changelog.yml@release
with:
ref: ${{github.ref_name}}
```
This works best in conjuction with the Calculate Version workflow.
### Draft Release
This workflow creates a draft release with the latest changes. This works when all your features are
developed in a feature branch and merged using a pull request.
This works well with the calculate version workflow.
```yaml
name: Prepare Release
on:
push:
branches: [ release ]
paths-ignore:
- '**.md'
jobs:
calculate_next_version:
uses: codenamephp/workflows.common/.github/workflows/calculate-next-version.yml@release
draft_release:
needs: calculate_next_version
uses: codenamephp/workflows.common/.github/workflows/draft-release.yml@release
with:
version: ${{ needs.calculate_next_version.outputs.version }}
```
### Update Release Versions
This workflow is intended for reusable workflow repos (like this one). It will update the major and minor tags.
```yaml
name: Update Release Versions
on:
release:
types:
- published
jobs:
update_release_versions:
uses: codenamephp/workflows.common/.github/workflows/updateReleaseVersions.yml@release
with:
version: ${{ github.event.release.tag_name }}
release_ref: ${{ github.event.release.target_commitish }}
```
## Examples
### Prepare Relase
This workflow can be used to automatically prepare a release. It will calculate the next version, update
the changelog and create a draft release. This is based on a dedicated release branch.
```yaml
name: Prepare Release
on:
push:
branches: [ release ]
paths-ignore:
- '**.md'
jobs:
calculate_next_version:
uses: codenamephp/workflows.common/.github/workflows/calculate-next-version.yml@release
draft_release:
needs: calculate_next_version
uses: codenamephp/workflows.common/.github/workflows/draft-release.yml@release
with:
version: ${{ needs.calculate_next_version.outputs.version }}
update_changelog:
uses: codenamephp/workflows.common/.github/workflows/update-changelog.yml@release
needs: calculate_next_version
with:
ref: ${{github.ref_name}}
future-release: ${{ needs.calculate_next_version.outputs.version }}
release-branch: 'release'
```