Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions .github/workflows/ci-python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ on:
- compass/**
- .github/workflows/ci-python.yml
- pyproject.toml
- "*.lock"
- pixi.lock
pull_request:
paths:
- compass/**
- .github/workflows/ci-python.yml
- pyproject.toml
- "*.lock"
- pixi.lock
workflow_dispatch:

jobs:
Expand Down Expand Up @@ -56,6 +56,7 @@ jobs:
environments: pdev

- run: |
pixi reinstall -e pdev --locked NREL-COMPASS
pixi run -e pdev --locked tests-u

unit-tests:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Rust checks
name: Rust Checks

on:
push:
Expand All @@ -12,21 +12,21 @@ on:
- Cargo.lock
- .github/workflows/ci-rust.yml
- pyproject.toml
- "*.lock"
- pixi.lock
pull_request:
paths:
- crates/**
- Cargo.toml
- Cargo.lock
- .github/workflows/ci-rust.yml
- pyproject.toml
- "*.lock"
- pixi.lock
schedule:
- cron: '0 5 * * 1'

jobs:
check:
name: Rust - Check
name: Rust - Cargo Check
runs-on: ubuntu-latest
steps:
- name: Checkout sources
Expand All @@ -53,7 +53,7 @@ jobs:
lints:
# Only run tests if code looks OK
needs: check
name: Rust - Lint
name: Rust - Clippy Lint
runs-on: ubuntu-latest
steps:
- name: Checkout sources
Expand Down Expand Up @@ -84,7 +84,7 @@ jobs:
test:
# Only run tests if code looks OK
needs: check
name: Rust - Test
name: Rust - Tests
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
Expand All @@ -110,7 +110,7 @@ jobs:
- run: pixi run -e rdev tests-r

publish-dry:
name: Rust - Publish (dry-run)
name: Rust - Publishing (dry-run)
# Only run tests if code looks OK
needs: check
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ on:
- compass/**
- .github/workflows/docs.yml
- pyproject.toml
- "*.lock"
- pixi.lock
push:
branches: [main]
paths:
- compass/**
- .github/workflows/docs.yml
- pyproject.toml
- "*.lock"
- pixi.lock
release:
types: [created, published]
workflow_dispatch:
Expand Down
70 changes: 0 additions & 70 deletions .github/workflows/update_pixi_lock.yaml

This file was deleted.

13 changes: 10 additions & 3 deletions docs/source/dev/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -377,10 +377,17 @@ When you are ready to release a new version of COMPASS, please follow these step
5) Click on the "Select Tag" dropdown and type in a **new** tag. Be sure to follow `Semantic Versioning <https://semver.org/>`_. You may be prompted to create the new tag - make sure to do so
6) Proofread the release notes and make any necessary adjustments
7) Click "Publish Release"
8) Once the release is published and the tag has been created, verify that a PR has been opened to update the pixi lockfile (you may have to wait some time for the GHA to run)
9) Fill out any missing details in the PR (set yourself as the assignee, add any relevant project and milestone details, etc.)
10) Request a review from another core COMPASS developer and merge the PR once approved
8) Once the release is published and the tag has been created, you need to manually update the pixi lockfile:

a) Check out a new branch (e.g., ``update-lockfile-vX.Y.Z``)
b) Run ``pixi update nrel-compass`` to update the lockfile with the new COMPASS version
c) If needed, run ``pixi reinstall`` or ``pixi reinstall -e pdev`` to ensure the environment is consistent
d) Commit the updated ``pixi.lock`` file
e) Push your branch and open a PR with a title like "Update pixi lockfile for vX.Y.Z release"
f) Fill out any missing details in the PR (set yourself as the assignee, add any relevant project and milestone details, etc.)
g) Request a review from another core COMPASS developer and merge the PR once approved

Congratulations, you have just released a new version of COMPASS!

You may want to verify that the release has been published to `PyPi <https://pypi.org/project/NREL-COMPASS/>`_
(if not, check the "Upload to PyPi" GitHub Action).