-
Notifications
You must be signed in to change notification settings - Fork 30
Prepare repo for release #664
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| --- | ||
|
|
||
| - [ ] `CHANGELOG.md`'s "Unreleased" section has been updated, if applicable. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: build | ||
|
|
||
| on: | ||
| pull_request: {} | ||
| workflow_dispatch: {} | ||
| push: | ||
| branches: | ||
| - 'master' | ||
| tags-ignore: | ||
| - '**' | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-java@v4 | ||
| with: | ||
| distribution: 'zulu' | ||
| java-version-file: .github/workflows/.java-version | ||
| - uses: gradle/actions/setup-gradle@v4 | ||
|
|
||
| - run: ./gradlew build dokkaHtmlMultiModule | ||
|
|
||
| - run: ./gradlew publish | ||
| if: ${{ github.ref == 'refs/heads/master' && github.repository == 'sqldelight/sql-psi' }} | ||
| env: | ||
| ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME_APP_CASH }} | ||
| ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD_APP_CASH }} | ||
| ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_SECRET_KEY }} | ||
| ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.GPG_SECRET_PASSPHRASE }} | ||
|
|
||
| - name: Deploy docs to website | ||
| if: ${{ github.ref == 'refs/heads/master' && github.repository == 'sqldelight/sql-psi' }} | ||
| uses: JamesIves/github-pages-deploy-action@releases/v3 | ||
| with: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| BRANCH: site | ||
| FOLDER: build/dokka/htmlMultiModule | ||
| TARGET_FOLDER: docs/latest/ | ||
| CLEAN: true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| name: release | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - '**' | ||
|
|
||
| jobs: | ||
| release: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-java@v4 | ||
| with: | ||
| distribution: 'zulu' | ||
| java-version-file: .github/workflows/.java-version | ||
| - uses: gradle/actions/setup-gradle@v4 | ||
|
|
||
| - run: ./gradlew publish | ||
| env: | ||
| ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME_APP_CASH }} | ||
| ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD_APP_CASH }} | ||
| ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.GPG_SECRET_KEY }} | ||
| ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.GPG_SECRET_PASSPHRASE }} | ||
|
|
||
| - name: Extract release notes | ||
| id: extract-release-notes | ||
| uses: ffurrer2/extract-release-notes@v2 | ||
| with: | ||
| release_notes_file: RELEASE_NOTES.md | ||
|
|
||
| - name: Create GitHub release | ||
| run: gh release create ${{ github.ref_name }} --notes-file RELEASE_NOTES.md | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - run: ./gradlew dokkaHtmlMultiModule | ||
|
|
||
| - name: Deploy docs to website | ||
| uses: JamesIves/github-pages-deploy-action@releases/v3 | ||
| with: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| BRANCH: site | ||
| FOLDER: build/dokka/htmlMultiModule | ||
| TARGET_FOLDER: docs/1.x/ | ||
| CLEAN: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Change Log | ||
|
|
||
| ## Unreleased | ||
|
|
||
| Nothing yet! | ||
|
|
||
| ## 0.4.10 | ||
|
|
||
| ## 0.4.9 | ||
|
|
||
| ## 0.4.8 | ||
|
|
||
| ## 0.4.7 | ||
|
|
||
| ## 0.4.6 | ||
|
|
||
| ## 0.4.5 | ||
|
|
||
| ## 0.4.4 | ||
|
|
||
| ## 0.4.3 | ||
|
|
||
| ## 0.4.2 | ||
|
|
||
| ## 0.4.1 | ||
|
|
||
| ## 0.4.0 | ||
|
|
||
| ## 0.3.17 | ||
|
|
||
| ## 0.3.15 | ||
|
|
||
| ## 0.3.14 | ||
|
|
||
| ## 0.3.12 | ||
|
|
||
| ## 0.3.11 | ||
|
|
||
| ## 0.3.10 | ||
|
|
||
| ## 0.3.9 | ||
|
|
||
| ## 0.3.8 | ||
|
|
||
| ## 0.3.7 | ||
|
|
||
| ## 0.3.6 | ||
|
|
||
| ## 0.3.5 | ||
|
|
||
| ## 0.3.4 | ||
|
|
||
| ## 0.3.3 | ||
|
|
||
| ## 0.3.2 | ||
|
|
||
| ## 0.3.1 | ||
|
|
||
| ## 0.3.0 | ||
|
|
||
| ## 0.2.4 | ||
|
|
||
| ## 0.2.3 | ||
|
|
||
| ## 0.2.2 | ||
|
|
||
| ## 0.2.1 | ||
|
|
||
| ## 0.2.0 | ||
|
|
||
| ## 0.1.9 | ||
|
|
||
| ## 0.1.8 | ||
|
|
||
| ## 0.1.7 | ||
|
|
||
| ## 0.1.6 | ||
|
|
||
| ## 0.1.5 | ||
|
|
||
| ## 0.1.4 | ||
|
|
||
| ## 0.1.3 | ||
|
|
||
| ## 0.1.2 | ||
|
|
||
| ## 0.1.1 | ||
|
|
||
| ## 0.1.0 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,37 @@ | ||
| Releasing | ||
| ========= | ||
| # Releasing | ||
|
|
||
| 1. Change the version in `gradle.properties` to a non-SNAPSHOT verson. | ||
| 2. Update the `CHANGELOG.md` for the impending release. | ||
| 3. Update the `README.md` with the new version. | ||
| 4. `git commit -am "Prepare for release X.Y.Z."` (where X.Y.Z is the new version) | ||
| 5. `./gradlew clean publish --no-parallel`. | ||
| 6. Visit [Sonatype Nexus](https://oss.sonatype.org/) and promote the artifact. | ||
| 7. `git tag -a X.Y.Z -m "Version X.Y.Z"` (where X.Y.Z is the new version) | ||
| 8. Update the `gradle.properties` to the next SNAPSHOT version. | ||
| 9. `git commit -am "Prepare next development version."` | ||
| 10. `git push && git push --tags` | ||
| 11. Update the sample app to the release version and send a PR. | ||
| 1. Update the `VERSION_NAME` in `gradle.properties` to the release version. | ||
|
|
||
| If step 6 or 7 fails, drop the Sonatype repo, fix the problem, commit, and start again at step 5. | ||
| 2. Update the `CHANGELOG.md`: | ||
| 1. Change the `Unreleased` header to the release version. | ||
| 2. Add a link URL to ensure the header link works. | ||
| 3. Add a new `Unreleased` section to the top. | ||
|
|
||
| 3. Commit | ||
|
|
||
| Prerequisites | ||
| ------------- | ||
| ``` | ||
| $ git commit -am "Prepare version X.Y.Z" | ||
| ``` | ||
|
|
||
| In `~/.gradle/gradle.properties`, set the following: | ||
| 4. Tag | ||
|
|
||
| * `SONATYPE_NEXUS_USERNAME` - Sonatype username for releasing to `com.squareup`. | ||
| * `SONATYPE_NEXUS_PASSWORD` - Sonatype password for releasing to `com.squareup`. | ||
| ``` | ||
| $ git tag -am "Version X.Y.Z" X.Y.Z | ||
| ``` | ||
|
|
||
| 5. Update the `VERSION_NAME` in `gradle.properties` to the next "SNAPSHOT" version. | ||
|
|
||
| 6. Commit | ||
|
|
||
| ``` | ||
| $ git commit -am "Prepare next development version" | ||
| ``` | ||
|
|
||
| 7. Push! | ||
|
|
||
| ``` | ||
| $ git push && git push --tags | ||
| ``` | ||
|
|
||
| This will trigger a GitHub Action workflow which will create a GitHub release and upload the | ||
| release artifacts to Maven Central. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have docs now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They're at least generated. Not sure how useful they are...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://sqldelight.github.io/sql-psi/docs/latest/