-
Notifications
You must be signed in to change notification settings - Fork 0
136 lines (117 loc) · 6.19 KB
/
release-workflows.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
name: Release Workflow
on: [push]
jobs:
release-management:
runs-on: ubuntu-latest
steps:
# Step 1: Checkout the code
- name: Checkout Code
uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }} # Checkout the correct branch name
fetch-depth: 0 # Fetch the whole repo history
# Documentation: https://github.com/actions/checkout
# Explanation: This step checks out the source code from the GitHub repository, ensuring that the workflow has access to the latest version of the code.
# Step 2: Install PHP extensions
- name: Set up PHP and install extensions
uses: shivammathur/setup-php@v2
with:
php-version: '8.2'
extensions: zip, gd
# Documentation: https://github.com/shivammathur/setup-php
# Explanation: This step sets up PHP 7.4 and installs the required extensions (`zip` and `gd`) that are necessary for your Composer dependencies.
# Step 3: Install Node.js dependencies using npm
- name: Install npm dependencies
uses: actions/setup-node@v3
with:
node-version: '18.x' # Specify Node.js version
# Documentation: https://github.com/actions/setup-node
# Explanation: This step sets up a Node.js environment and installs the project's dependencies listed in the `package.json` file using npm.
# Step 3: Build the node_modules
- run: npm install
# Documentation: https://docs.npmjs.com/cli/v7/commands/npm-install
# Explanation: This step runs `npm install` to install the Node.js dependencies required for the project.
# Step 3: Webpack the whole thing
- run: npm run build
# Step 4: Install PHP dependencies using Composer
- name: Install Composer dependencies
run: composer install --no-progress --no-interaction --prefer-dist --ignore-platform-req=ext-zip --ignore-platform-req=ext-gd
env:
COMPOSER_ROOT_VERSION: 2.7.7
# Documentation: https://getcomposer.org/doc/03-cli.md#install
# Explanation: This step runs `composer install` to install the PHP dependencies required for the project. It also ignores platform requirements for `ext-zip` and `ext-gd` to avoid issues if extensions are not detected correctly in the environment.
# Step 5: Generate Git version information
- name: Git Version
id: version
uses: codacy/git-version@2.7.1
with:
release-branch: main
# Documentation: https://github.com/marketplace/actions/git-version
# Explanation: This step calculates the version of the software based on the Git tags and branch information, storing the result in the `version` output.
# Step 6: Extract repository description
- name: Extract repository description
id: repo-description
run: |
description=$(jq -r '.description' <(curl -s https://api.github.com/repos/${{ github.repository }}))
echo "REPO_DESCRIPTION=$description" >> $GITHUB_ENV
# Documentation: https://docs.github.com/en/rest/reference/repos#get-a-repository
# Explanation: This step retrieves the description of the GitHub repository using the GitHub API and stores it in the environment variables.
# Step 7: Run Changelog CI
- name: Run Changelog CI
if: github.ref == 'refs/heads/master'
uses: saadmk11/changelog-ci@v1.1.2
with:
release_version: ${{ steps.version.outputs.version }}
config_file: changelog-ci-config.json
# Documentation: https://github.com/saadmk11/changelog-ci
# Explanation: This step generates a changelog for the current release using the Changelog CI tool.
# Step 8: Output the version
- name: Use the version
run: |
echo ${{ steps.version.outputs.version }}
# Explanation: This step outputs the calculated version number to the console for reference.
# Step 9: Output the version
- name: Copy the packadge files into the packadge
run: |
mkdir -p package/opencatalogi
cp -r README.md CHANGELOG.md LICENSE.md psalm.xml package.json package-lock.json openapi.json composer.json composer.lock appinfo css img js lib node_modules src templates vendor package/opencatalogi/
# Step 12: Create the ZIP archive with code in opencatalogi directory
- name: Create ZIP
run: |
cd package && zip -r ../opencatalogi.zip opencatalogi
# Step 13: Create the TAR.GZ archive with code in opencatalogi directory
- name: Create Tarball
run: |
cd package && tar -czf ../opencatalogi.tar.gz opencatalogi
# Step 14: Remove the package directory after creating archives and before freezing the code in an realease
- name: Clean up package directory and add dev files
run: |
cd package && rm -rf vendor js node_modules
cd ../ && cp -r docs tests .babelrc package/opencatalogi/
# Step 12: Create the ZIP archive with code in opencatalogi directory
- name: Create ZIP
run: |
cd package && zip -r ../sourcecode.zip opencatalogi
# Step 13: Create the TAR.GZ archive with code in opencatalogi directory
- name: Create Tarball
run: |
cd package && tar -czf ../sourcecode.tar.gz opencatalogi
# Step 14: Remove the package directory after creating archives and before freezing the code in an realease
- name: Clean up package directory
run: |
rm -rf package
# Step 10: Create a new release on GitHub
- name: Upload Release
uses: ncipollo/release-action@v1.12.0
with:
# bodyFile: 'opencatalogi/changelog.md'
artifacts: |
LICENSE.md
opencatalogi.zip
opencatalogi.tar.gz
sourcecode.zip
sourcecode.tar.gz
token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ steps.version.outputs.version }}
# Documentation: https://github.com/ncipollo/release-action
# Explanation: This step creates a new release on GitHub, uploading the generated release files, and tagging the release with the calculated version.