Merge pull request #31 from Automattic/release

Create releases

Author: psrpinto

.github/workflows/.gitignore

@@ -0,0 +1 @@
+.secrets

.github/workflows/release.yml

@@ -0,0 +1,55 @@
+# Create a draft release when a tag is pushed
+name: Create a release
+
+on:
+  # Allow manual trigger from the Actions tab:
+  # https://github.com/Automattic/wp-openid-connect-server/actions/workflows/release.yml
+  workflow_dispatch:
+
+  push:
+    tags: ['v*']
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install composer dependencies
+        run: composer install --no-ansi --no-dev --no-interaction --no-plugins --no-scripts --optimize-autoloader
+
+      - name: Generate readme.txt
+        run: php bin/transform-readme.php
+
+      - name: Create directory for release
+        run: mkdir /tmp/release
+
+      - name: Copy all files to release directory
+        run: cp -r ./* /tmp/release/
+
+      - name: Remove unnecessary files and directories
+        run: |
+          rm -rf /tmp/release/.github
+          rm -rf /tmp/release/.git
+          rm -rf /tmp/release/bin
+          rm -rf /tmp/release/README.md
+          rm -rf /tmp/release/.wp-env.json
+          rm -rf /tmp/release/phpcs.xml
+
+      - name: Move and rename release directory
+        run: mv /tmp/release wp-openid-connect-server
+
+      - name: Create archive for release
+        run: tar -cvzf wp-openid-connect-server-${{ github.ref_name }}.tar.gz wp-openid-connect-server
+
+      - name: Create release
+        uses: ncipollo/release-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref_name }}
+          artifacts: "wp-openid-connect-server-${{ github.ref_name }}.tar.gz"
+          artifactErrorsFailBuild: true
+          draft: true

CONTRIBUTING.md

@@ -14,3 +14,26 @@ wp-env run cli "wp rewrite structure '/%postname%'"
 ```
 
 The site is now available at http://localhost:8888.
+
+
+## Release
+Plugin releases are automatically created through a GitHub Action, which is executed whenever a tag of the form `vX.Y.Z` is pushed. You can create and push a tag as follows.
+
+First find the latest tag:
+
+```shell
+# Fetch tags from origin
+git fetch
+
+# Returns the latest tag, e.g. v0.1.0
+git describe --tags --abbrev=0
+```
+
+Then create and push a tag that increments the latest one as per [Semantic Versioning](https://semver.org/):
+
+```shell
+git tag v0.1.1
+git push origin v0.1.1
+```
+
+The [GitHub Action](https://github.com/Automattic/wp-openid-connect-server/actions) will launch automatically, and when completed will have created a **draft release** for the tag that was pushed. You should then edit that release to provide a meaningful title and description (ideally including a [changelog](https://keepachangelog.com/en/1.0.0/)), then publish the release.