Skip to content

Commit

Permalink
Move to GitHub Container Registry
Browse files Browse the repository at this point in the history
Docker Hub was planning to sunset their free plan: https://www.docker.com/developers/free-team-faq/. Although they have backed down from doing this, it still seems better to centralize our infrastructure dependencies on GitHub.
  • Loading branch information
domenic committed May 5, 2023
1 parent fd6ec05 commit 59c6e78
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 41 deletions.
65 changes: 39 additions & 26 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,40 +1,53 @@
name: Build
name: Wattsi CI
on:
pull_request:
branches:
- main
branches: ['main']
push:
branches:
- main
branches: ['main']

env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}

jobs:
build:
name: Build
runs-on: ubuntu-22.04
env:
IMAGE_NAME: whatwg/wattsi
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v3
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: docker build
run: make docker
# This also serves as a *very* minimal test of the executable.
- name: docker run (get version)
- name: Create version file
run: |
WATTSI_VERSION=$(docker run "$IMAGE_NAME" --version | cut -d' ' -f2)
echo "WATTSI_VERSION=$WATTSI_VERSION" >> $GITHUB_ENV
- name: docker tag
git rev-list --count HEAD > src/version.inc
- name: Build
uses: docker/build-push-action@v4
with:
context: .
load: true
tags: ${{ env.IMAGE_NAME }}:test
- name: Test
# This minimal test also saves the version for us to use as a tag.
run: |
docker tag "$IMAGE_NAME" "$IMAGE_NAME:$WATTSI_VERSION"
docker tag "$IMAGE_NAME" "$IMAGE_NAME:latest"
- name: docker login
WATTSI_VERSION=$(docker run "$IMAGE_NAME:test" --version | cut -d' ' -f2)
echo "WATTSI_VERSION=$WATTSI_VERSION" >> $GITHUB_ENV
- name: Login
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
uses: docker/login-action@v1
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKER_HUB_USERNAME }}
password: ${{ secrets.DOCKER_HUB_TOKEN }}
- name: docker push
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build and push
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
run: |
docker push "$IMAGE_NAME:$WATTSI_VERSION"
docker push "$IMAGE_NAME:latest"
uses: docker/build-push-action@v4
with:
context: .
push: true
tags: |
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.WATTSI_VERSION }}
${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ clean:

docker:
git rev-list --count HEAD > src/version.inc
docker pull whatwg/wattsi || true
docker build --pull --cache-from whatwg/wattsi --tag whatwg/wattsi .
docker build --tag whatwg/wattsi .

manual:
git rev-list --count HEAD > src/version.inc
Expand Down
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,29 @@ Wattsi is a build tool for creating the [HTML Standard](https://html.spec.whatwg
## Features

Currently:
* Number the sections
* Create Table of Contents
* Cross-reference `<span>` and `<code>` to `<dfn>`
* Create small TOC
* Cross-reference back (`<dfn>` menu)
* Strip out unused references
* Check for missing references
* Spec splitting
* Add output for `<wpt>` elements
* Add MDN annotations
* Add syntax-highlighting markup to `<pre>` contents

* Number the sections
* Create Table of Contents
* Cross-reference `<span>` and `<code>` to `<dfn>`
* Create small TOC
* Cross-reference back (`<dfn>` menu)
* Strip out unused references
* Check for missing references
* Spec splitting
* Add output for `<wpt>` elements
* Add MDN annotations
* Add syntax-highlighting markup to `<pre>` contents

## Wattsi syntax

For documentation on the "Wattsi language", e.g. things like `data-x` or `w-nodev`, see [Syntax.md](./Syntax.md).

## Building and running Wattsi with Docker

The easiest way to use Wattsi is via [Docker](https://www.docker.com/). Once you have Docker, you can download and run a copy of Wattsi from [Docker Hub](https://hub.docker.com/r/whatwg/wattsi) using
The easiest way to use Wattsi is via [Docker](https://www.docker.com/). Once you have Docker, you can download and run a copy of Wattsi from the [GitHub Container Registry](https://github.com/whatwg/wattsi/pkgs/container/wattsi) using

```bash
docker run whatwg/wattsi
docker run ghcr.io/whatwg/wattsi
```

The [HTML build tools](https://github.com/whatwg/html-build) will automatically attempt to use this form if they cannot find a locally-installed copy of Wattsi.
Expand Down

0 comments on commit 59c6e78

Please sign in to comment.