-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'refs/remotes/official/main' into attrib…
…utes-as-labels # Conflicts: # collector/src/main/java/io/prometheus/jmx/JmxScraper.java # docs/README.md
- Loading branch information
Showing
705 changed files
with
12,089 additions
and
3,592 deletions.
There are no files selected for viewing
This file contains 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 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,82 @@ | ||
name: Deploy Documentation to GitHub Pages | ||
|
||
on: | ||
# Runs on pushes targeting the 1.0.x branch | ||
push: | ||
branches: | ||
- main | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
# Default to bash | ||
defaults: | ||
run: | ||
shell: bash | ||
|
||
jobs: | ||
# Build job | ||
build: | ||
runs-on: ubuntu-24.04 | ||
env: | ||
HUGO_VERSION: 0.115.4 | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
fetch-tags: 'true' | ||
fetch-depth: 0 | ||
- name: Set up JDK | ||
uses: actions/setup-java@v4 | ||
with: | ||
java-version: 17 | ||
distribution: temurin | ||
cache: 'maven' | ||
- name: Install Hugo CLI | ||
run: | | ||
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \ | ||
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb | ||
- name: Setup Pages | ||
id: pages | ||
uses: actions/configure-pages@v5 | ||
- name: Install Node.js dependencies | ||
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true" | ||
working-directory: ./docs | ||
- name: Build with Hugo | ||
env: | ||
# For maximum backward compatibility with Hugo modules | ||
HUGO_ENVIRONMENT: production | ||
HUGO_ENV: production | ||
run: | | ||
hugo \ | ||
--gc \ | ||
--minify \ | ||
--baseURL "${{ steps.pages.outputs.base_url }}/" | ||
working-directory: ./docs | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: ./docs/public | ||
|
||
# Deployment job | ||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-24.04 | ||
needs: build | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains 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 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 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
Binary file not shown.
This file contains 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,3 +1,2 @@ | ||
* Fabian Stäber <[email protected]> @fstab | ||
* Doug Hoard <[email protected]> @dhoard | ||
* Tom Wilkie <[email protected]> @tomwilkie | ||
* Fabian Stäber <[email protected]> @fstab |
This file contains 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,98 +1,35 @@ | ||
# Maintainer Notes | ||
|
||
Shell scripts to build and release are located int the `tools` directory. | ||
## Release | ||
|
||
## Build a pre-release | ||
___ | ||
Verifyica [Pipeliner](https://github.com/verifyica-team/pipeliner) is used to run the release pipeline. | ||
|
||
**Pre-release builds are not source controlled (no branch, no tag)** | ||
- builds & runs integration tests using smoke test containers | ||
- creates & copies release artifacts | ||
- generates signatures and checksums for release artifacts | ||
- creates the release branch | ||
- tags the release | ||
- updates the `main` branch for development | ||
|
||
Command | ||
**Notes** | ||
|
||
```shell | ||
./tools/build-and-copy.sh <version> <destination directory> | ||
``` | ||
- `gpg` is required | ||
- `sha256sum` is required | ||
|
||
Example | ||
### Example: | ||
|
||
```shell | ||
./tools/build-and-copy.sh 0.20.0-ALPHA-1 "/tmp/" | ||
./pipeliner -Prelease=<RELEASE VERSION> release.yaml | ||
``` | ||
|
||
The jars will be located in `/tmp` | ||
|
||
## Build and stage | ||
___ | ||
|
||
Release builds are source controlled. | ||
|
||
- Creates a `release-<version>` branch | ||
- Creates a `<version>` tag | ||
- Pushes the branch and tag to GitHub | ||
- Stages the release to Maven Central | ||
|
||
### Step 1 | ||
|
||
Command | ||
### Concrete Example: | ||
|
||
```shell | ||
./tools/build-and-stage.sh <version> | ||
./pipeliner -Prelease=1.1.0 release.yaml | ||
``` | ||
|
||
Example | ||
|
||
```shell | ||
./tools/build-and-stage.sh 0.20.0 | ||
``` | ||
|
||
### Step 2 | ||
|
||
Download the staged artifacts from Maven Central and run the integration test suite. | ||
|
||
``` | ||
https://oss.sonatype.org/#stagingRepositories | ||
``` | ||
|
||
Example | ||
|
||
```shell | ||
/home/dhoard/Downloads/jmx_prometheus_javaagent-0.20.0.jar | ||
/home/dhoard/Downloads/jmx_prometheus_httpserver-0.20.0.jar | ||
``` | ||
## Release Artifacts | ||
|
||
Command | ||
Release artifacts will be located in the `RELEASE` directory. | ||
|
||
```shell | ||
./tools/patch-and-run-integration-test-suite.sh <javaagent.jar> <httpserver.jar> | ||
``` | ||
|
||
Example | ||
|
||
```shell | ||
./tools/patch-and-run-integration-test-suite.sh /home/dhoard/Downloads/jmx_prometheus_javaagent-0.20.0.jar /home/dhoard/Downloads/jmx_prometheus_httpserver-0.20.0.jar | ||
``` | ||
|
||
### Step 3 | ||
|
||
If the integration test suite in Step 2 passes, on Maven Central... | ||
|
||
- Click `Close` to trigger Sonatype's verification | ||
- Once closed, click `Release` | ||
|
||
|
||
### Step 4 | ||
|
||
Verify the files are available via Maven Central (Maven) | ||
|
||
Create a GitHub release | ||
|
||
### Step 5 | ||
|
||
Checkout the `main` branch and increment the version | ||
|
||
```shell | ||
git checkout main | ||
./tools/change-version.sh 1.0.0 | ||
git add -u | ||
git commit -m "prepare for next development iteration" | ||
``` | ||
Attach all files to the GitHub release. |
This file contains 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
Oops, something went wrong.