Skip to content

Commit 3bfd3d0

Browse files
Merge pull request ClusterCockpit#557 from ClusterCockpit/release/v1.5
Release/v1.5
2 parents c94f591 + 9c6075e commit 3bfd3d0

2 files changed

Lines changed: 52 additions & 38 deletions

File tree

CLAUDE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,21 @@ records, archives) at scale. All code changes must prioritize maximum throughput
341341
and minimal latency. Avoid unnecessary allocations, prefer streaming over
342342
buffering, and be mindful of lock contention. When in doubt, benchmark.
343343

344+
### Commit Message Convention
345+
346+
Commits must use conventional commit prefixes so goreleaser can generate the
347+
changelog automatically. Only commits with these prefixes appear in releases:
348+
349+
| Prefix | Changelog group |
350+
|---------|------------------------|
351+
| `feat:` | New Features |
352+
| `fix:` | Bug fixes |
353+
| `sec:` | Security updates |
354+
| `docs:` | Documentation updates |
355+
356+
Scoped variants are also recognised, e.g. `feat(api):`, `fix(deps):`.
357+
Commits without one of these prefixes are excluded from the changelog.
358+
344359
### Change Impact Analysis
345360

346361
For any significant change, you MUST:

README.md

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# NOTE
22

3-
While we do our best to keep the master branch in a usable state, there is no guarantee the master branch works.
4-
Please do not use it for production!
3+
While we do our best to keep the main branch in a usable state, there is no
4+
guarantee the main branch works. Please do not use it for production!
55

6-
Please have a look at the [Release
7-
Notes](https://github.com/ClusterCockpit/cc-backend/blob/master/ReleaseNotes.md)
6+
Please have a look at the [Release Notes](https://github.com/ClusterCockpit/cc-backend/blob/main/ReleaseNotes.md)
87
for breaking changes!
98

109
# ClusterCockpit REST and GraphQL API backend
@@ -41,7 +40,7 @@ For real-time integration with HPC systems, the backend can subscribe to
4140
state updates, providing an alternative to REST API polling.
4241

4342
Completed batch jobs are stored in a file-based job archive according to
44-
[this specification](https://github.com/ClusterCockpit/cc-specifications/tree/master/job-archive).
43+
[this specification](https://github.com/ClusterCockpit/cc-specifications/tree/main/job-archive).
4544
The backend supports authentication via local accounts, an external LDAP
4645
directory, and JWT tokens. Authorization for APIs is implemented with
4746
[JWT](https://jwt.io/) tokens created with public/private key encryption.
@@ -243,73 +242,73 @@ The effective configuration is logged at startup for verification.
243242

244243
## Project file structure
245244

246-
- [`.github/`](https://github.com/ClusterCockpit/cc-backend/tree/master/.github)
245+
- [`.github/`](https://github.com/ClusterCockpit/cc-backend/tree/main/.github)
247246
GitHub Actions workflows and dependabot configuration for CI/CD.
248-
- [`api/`](https://github.com/ClusterCockpit/cc-backend/tree/master/api)
247+
- [`api/`](https://github.com/ClusterCockpit/cc-backend/tree/main/api)
249248
contains the API schema files for the REST and GraphQL APIs. The REST API is
250249
documented in the OpenAPI 3.0 format in
251250
[./api/swagger.yaml](./api/swagger.yaml). The GraphQL schema is in
252251
[./api/schema.graphqls](./api/schema.graphqls).
253-
- [`cmd/cc-backend`](https://github.com/ClusterCockpit/cc-backend/tree/master/cmd/cc-backend)
252+
- [`cmd/cc-backend`](https://github.com/ClusterCockpit/cc-backend/tree/main/cmd/cc-backend)
254253
contains the main application entry point and CLI implementation.
255-
- [`configs/`](https://github.com/ClusterCockpit/cc-backend/tree/master/configs)
254+
- [`configs/`](https://github.com/ClusterCockpit/cc-backend/tree/main/configs)
256255
contains documentation about configuration and command line options and required
257256
environment variables. Sample configuration files are provided.
258-
- [`init/`](https://github.com/ClusterCockpit/cc-backend/tree/master/init)
257+
- [`init/`](https://github.com/ClusterCockpit/cc-backend/tree/main/init)
259258
contains an example of setting up systemd for production use.
260-
- [`internal/`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal)
259+
- [`internal/`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal)
261260
contains library source code that is not intended for use by others.
262-
- [`api`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/api)
261+
- [`api`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/api)
263262
REST API handlers and NATS integration
264-
- [`archiver`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/archiver)
263+
- [`archiver`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/archiver)
265264
Job archiving functionality
266-
- [`auth`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/auth)
265+
- [`auth`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/auth)
267266
Authentication (local, LDAP, OIDC) and JWT token handling
268-
- [`config`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/config)
267+
- [`config`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/config)
269268
Configuration management and validation
270-
- [`graph`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/graph)
269+
- [`graph`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/graph)
271270
GraphQL schema and resolvers
272-
- [`importer`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/importer)
271+
- [`importer`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/importer)
273272
Job data import and database initialization
274-
- [`metricdispatch`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/metricdispatch)
273+
- [`metricdispatch`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/metricdispatch)
275274
Dispatches metric data loading to appropriate backends
276-
- [`repository`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/repository)
275+
- [`repository`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/repository)
277276
Database repository layer for jobs and metadata
278-
- [`routerConfig`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/routerConfig)
277+
- [`routerConfig`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/routerConfig)
279278
HTTP router configuration and middleware
280-
- [`tagger`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/tagger)
279+
- [`tagger`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/tagger)
281280
Job classification and application detection
282-
- [`taskmanager`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/taskmanager)
281+
- [`taskmanager`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/taskmanager)
283282
Background task management and scheduled jobs
284-
- [`metricstoreclient`](https://github.com/ClusterCockpit/cc-backend/tree/master/internal/metricstoreclient)
283+
- [`metricstoreclient`](https://github.com/ClusterCockpit/cc-backend/tree/main/internal/metricstoreclient)
285284
Client for cc-metric-store queries
286-
- [`pkg/`](https://github.com/ClusterCockpit/cc-backend/tree/master/pkg)
285+
- [`pkg/`](https://github.com/ClusterCockpit/cc-backend/tree/main/pkg)
287286
contains Go packages that can be used by other projects.
288-
- [`archive`](https://github.com/ClusterCockpit/cc-backend/tree/master/pkg/archive)
287+
- [`archive`](https://github.com/ClusterCockpit/cc-backend/tree/main/pkg/archive)
289288
Job archive backend implementations (filesystem, S3, SQLite)
290-
- [`metricstore`](https://github.com/ClusterCockpit/cc-backend/tree/master/pkg/metricstore)
289+
- [`metricstore`](https://github.com/ClusterCockpit/cc-backend/tree/main/pkg/metricstore)
291290
In-memory metric data store with checkpointing and metric loading
292-
- [`tools/`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools)
291+
- [`tools/`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools)
293292
Additional command line helper tools.
294-
- [`archive-manager`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/archive-manager)
293+
- [`archive-manager`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools/archive-manager)
295294
Commands for getting infos about an existing job archive, importing jobs
296295
between archive backends, and converting archives between JSON and Parquet formats.
297-
- [`archive-migration`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/archive-migration)
296+
- [`archive-migration`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools/archive-migration)
298297
Tool for migrating job archives between formats.
299-
- [`convert-pem-pubkey`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/convert-pem-pubkey)
298+
- [`convert-pem-pubkey`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools/convert-pem-pubkey)
300299
Tool to convert external pubkey for use in `cc-backend`.
301-
- [`gen-keypair`](https://github.com/ClusterCockpit/cc-backend/tree/master/tools/gen-keypair)
300+
- [`gen-keypair`](https://github.com/ClusterCockpit/cc-backend/tree/main/tools/gen-keypair)
302301
contains a small application to generate a compatible JWT keypair. You find
303302
documentation on how to use it
304-
[here](https://github.com/ClusterCockpit/cc-backend/blob/master/docs/JWT-Handling.md).
305-
- [`web/`](https://github.com/ClusterCockpit/cc-backend/tree/master/web)
306-
Server-side templates and frontend-related files:
307-
- [`frontend`](https://github.com/ClusterCockpit/cc-backend/tree/master/web/frontend)
303+
[here](https://github.com/ClusterCockpit/cc-backend/blob/main/docs/JWT-Handling.md).
304+
- [`web/`](https://github.com/ClusterCockpit/cc-backend/tree/main/web)
305+
Server-side templates and frontend-related files:
306+
- [`frontend`](https://github.com/ClusterCockpit/cc-backend/tree/main/web/frontend)
308307
Svelte components and static assets for the frontend UI
309-
- [`templates`](https://github.com/ClusterCockpit/cc-backend/tree/master/web/templates)
308+
- [`templates`](https://github.com/ClusterCockpit/cc-backend/tree/main/web/templates)
310309
Server-side Go templates, including monitoring views
311-
- [`gqlgen.yml`](https://github.com/ClusterCockpit/cc-backend/blob/master/gqlgen.yml)
310+
- [`gqlgen.yml`](https://github.com/ClusterCockpit/cc-backend/blob/main/gqlgen.yml)
312311
Configures the behaviour and generation of
313312
[gqlgen](https://github.com/99designs/gqlgen).
314-
- [`startDemo.sh`](https://github.com/ClusterCockpit/cc-backend/blob/master/startDemo.sh)
313+
- [`startDemo.sh`](https://github.com/ClusterCockpit/cc-backend/blob/main/startDemo.sh)
315314
is a shell script that sets up demo data, and builds and starts `cc-backend`.

0 commit comments

Comments
 (0)