Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically publish releases on CI #1510

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Automatically publish releases on CI #1510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09e0f19
Split workflows into build and release
Egorand Apr 6, 2023
a3555e6
Run release on tag pushes and set VERSION_NAME to tag value
Egorand Apr 6, 2023
a7c2b65
Add release trigger
Egorand Apr 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/build-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Build

on:
push:
branches-ignore:
- master
pull_request:

env:
GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx4g -Dorg.gradle.daemon=false -Dkotlin.incremental=false"

jobs:
jvm:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Validate Gradle Wrapper
uses: gradle/wrapper-validation-action@v1

- name: Configure JDK
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 19

- name: Test
run: ./gradlew build

build-docs:
runs-on: ubuntu-latest
if: github.repository == 'square/kotlinpoet'

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Configure JDK
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 19

- name: Prep docs
run: ./gradlew dokkaHtml

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.8

- name: Build mkdocs
run: |
pip3 install -r .github/workflows/mkdocs-requirements.txt
mkdocs build
67 changes: 17 additions & 50 deletions .github/workflows/build.yml → .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,21 @@
name: Build
name: Release

on: [push, pull_request]
on:
push:
branches:
- master
tags:
- '[0-9]+.[0-9]+*'
Comment on lines +7 to +8
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our tags have three numbers, not two. Also the dot needs escaped since it matches any character, not just a dot. However, I would recommend just removing this completely and instead just use a full wildcard ** like we do in other projects: https://github.com/cashapp/molecule/blob/trunk/.github/workflows/release.yaml#L3-L6

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is based on the discussion @swankjesse & I had - we wanted to have basic tag format validation, that would accept valid versions, even ones we don't normally use (e.g., "1.0-SQUARE"), and reject obviously incorrect ones (e.g., "hello").

release:
types: [published]

env:
GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx4g -Dorg.gradle.daemon=false -Dkotlin.incremental=false"

jobs:
jvm:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Validate Gradle Wrapper
uses: gradle/wrapper-validation-action@v1

- name: Configure JDK
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 19

- name: Test
run: ./gradlew build

build-docs:
publish:
runs-on: ubuntu-latest
if: github.repository == 'square/kotlinpoet' && github.ref != 'refs/heads/master'
if: github.repository == 'square/kotlinpoet'

steps:
- name: Checkout
Expand All @@ -39,34 +27,13 @@ jobs:
distribution: 'zulu'
java-version: 19

- name: Prep docs
run: ./gradlew dokkaHtml
- name: Set release version
if: startsWith(github.ref, 'refs/tags/')
run: echo "VERSION_NAME=${GITHUB_REF#refs/tags/}" >> gradle.properties
Comment on lines +30 to +32
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had a setup like this in RxAndroid that was mostly forced on us from the RxJava Travis CI infrastructure. Personally, I was glad to see it go away when we moved to GitHub Actions and I greatly prefer the explicit version. In other projects I'm editing the README and CHANGELOG when I release to indicate the next version so I'm not sure whether there's a ton of value in automating only one location.

If you want to go down the automating route I would like to see a workflow that's manually dispatched where the version is in the input. It would automatically update the README, migrate the CHANGELOG entries from an "Unreleased" section to a versioned section, and do the gradle.properties update/tag/update dance.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense.

Taking a step back, the main quality of life improvements I'd love to get from this change is not having to build the project locally (and risking using a wrong JDK or incorrect environment setup in general) for release, and not having to host signing keys on my machine - these can be achieved even without these extra workflow improvements. Given that this setup likely needs much more work to be pleasant to use, I feel like sticking with the basic requirements, and leaving the rest for later. Let me know if you have thoughts!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t like having to do 2 commits per release. Changing the property for the current release and again for the next snapshot is a bit clumsy.

I also don’t like how the tag and the property duplicate information.

I’d like to discuss our options on a VC, maybe next week?


- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.8

- name: Build mkdocs
run: |
pip3 install -r .github/workflows/mkdocs-requirements.txt
mkdocs build

publish:
runs-on: ubuntu-latest
if: github.repository == 'square/kotlinpoet' && github.ref == 'refs/heads/master'
needs:
- jvm

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Configure JDK
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 19
- name: Set snapshot version
if: !startsWith(github.ref, 'refs/tags/')
run: echo "VERSION_NAME=$(date +'%Y%m%d.%H%M%S').$(git rev-parse --short HEAD)" >> gradle.properties

- name: Upload Artifacts
run: ./gradlew publish
Expand Down
1 change: 0 additions & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
org.gradle.jvmargs='-Dfile.encoding=UTF-8'

GROUP=com.squareup
VERSION_NAME=1.14.0-SNAPSHOT
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this break the ability to do Maven local deploys for testing?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does, yep. This likely breaks more things, and will generally be non-ergonomic for local development.


POM_URL=https://github.com/square/kotlinpoet
POM_SCM_URL=https://github.com/square/kotlinpoet
Expand Down