Workflows for automated releases and github-pages builds

.github/workflows/ci.yml

@@ -10,6 +10,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with: 
+          fetch-depth: 0
+
       - uses: actions/setup-node@v4
         with:
           node-version-file: 'package.json'
@@ -36,6 +39,9 @@ jobs:
         os: [ubuntu-latest, windows-latest]
     steps:
       - uses: actions/checkout@v4
+        with: 
+          fetch-depth: 0
+
       - uses: actions/setup-node@v4
         with:
           node-version-file: 'package.json'
@@ -59,6 +65,9 @@ jobs:
         os: [ubuntu-latest, windows-latest]
     steps:
       - uses: actions/checkout@v4
+        with: 
+          fetch-depth: 0
+
       - uses: actions/setup-node@v4
         with:
           node-version-file: 'package.json'

.github/workflows/gh-pages.yml

@@ -0,0 +1,43 @@
+name: Deploy to GitHub Pages
+on: 
+  release:
+    types:
+      - published
+  workflow_dispatch:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with: 
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+          cache: 'npm'
+
+      - name: Install Node dependencies
+        run: npm ci
+
+      - name: Build the package
+        run: |
+            ASSET_PATH=/kinto-admin/ npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: build/
+
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment: 
+      name: github-pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to Github Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Create a release on tag
+on: 
+  push: 
+    tags:
+      - "v*.*.*"
+jobs:
+  build: 
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    env:
+      GH_TOKEN: ${{ github.token }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with: 
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+          cache: 'npm'
+
+      - name: Install Node dependencies
+        run: npm ci
+
+      - name: Build the package
+        run: |
+          npm run build:kinto-single
+          cd build
+          tar -cvf "$RUNNER_TEMP/kinto-admin-release.tar" *
+
+      - name: Create release if one doesn't exist yet
+        run: |
+          EXISTING_RELEASE=$(gh release view $GITHUB_REF --json="id" || echo '')
+          if [[ -z $EXISTING_RELEASE ]]; then
+              gh release create $GITHUB_REF --generate-notes -d
+          fi
+
+      - name: Upload built package to release
+        run: |
+          gh release upload $GITHUB_REF "$RUNNER_TEMP/kinto-admin-release.tar" --clobber

README.md

@@ -163,15 +163,47 @@ If you use `target.merkle.tree.file.name` it will render the string
 `foobar` and `target.proof.hash` will render `abcd`.
 
 ## Releasing
+Releases can be created through the GitHub UI or through git command line.
+
+### Through GitHub UI
+1. Create a new release as normal
+2. When tagging your release, enter a standard version number like `vX.Y.Z`
+3. After the release is published (including pre-release), built assets will be attached as files, including:
+    1. Source code based on the tagged commit
+    2. A single-server build for kinto-admin in a tar file (this may take a few minutes to show up)
+
+### Through git commands
+1. Tag a commit with `git tag --annotate vX.Y.Z` (this will become the version number in the built release)
+2. Push the tag with `git push origin vX.Y.Z` or `git push origin --tags`
+3. A new release draft will be created automatically with built assets attached as files, including:
+    1. Source code based on the tagged commit
+    2. A single-server build for kinto-admin in a tar file
+        1. This will have `ASSET_PATH=/v1/admin KINTO_ADMIN_SINGLE_SERVER=1` build property values
+        2. This may take a few minutes to show up
+4. Update the release body with detailed information
+5. Publish the release when ready
+
+## Deploying to github-pages
+
+### Repo configuration for forks
+1. Enable github pages and allow deployment from github actions 
+    1. Go Settings > Pages
+    2. Under "Build and deployment" choose Source > GitHub Actions
+2. Choose which branches should be allowed to deploy to pages
+    1. Go Settings > Environments > Github Pages
+    2. Under "Deployment branches and tags", configure which branches should be allowed to deploy to pages
+
+### Deployed automatically on release publish
+Github pages will automatically be updated upon release publishing. Version will be the tag created
+
+### Running the github action manually
+You can deploy to github pages manually for To deploy to github pages manually for any user acceptance testing you may want to do.
+1. Open Actions
+2. Select the "Deploy to Github Pages" action
+3. Select "Run workflow" and choose the branch you wish to build against
+4. Click "Run workflow"
+5. Kinto-admin will be deployed to `https://{owner}.github.io/kinto-admin`
 
-1. Bump the version number in `package.json` and run `npm i` to propagate that version to `package-lock.json`
-2. Commit with `git commit -a -m "Bump vX.Y.Z"`
-3. Create the tag with `git tag vX.Y.Z`
-4. Push the commit with `git push`
-5. Push the tag with `git push origin vX.Y.Z`
-6. Publish to GitHub Pages with `npm run publish-to-gh-pages`
-7. Draft a new release with the changelog
-8. Done!
 
 ## License