ci: Reorganize CI by LecrisUT · Pull Request #362 · spglib/spglib

LecrisUT · 2023-11-13T14:53:15Z

Rename the CI jobs so that they are more legible in the report
Fix concurrency on the imported jobs
Separated pre-commit to its own step
Add a static-analysis checker. I was experimenting with sonarcloud at CMake-Template repo. I think it could be useful to include it as an intermediate to clang-tidy. It is also polyglot, so it might pick up on more nieche problems. Postponed to Add a static-analysis checker #400
Mask overall CI status on main branch
Badges!!!

Depends on: #361 #358

codecov-commenter · 2023-11-14T11:04:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c945bae) 83.85% compared to head (5cc5eb5) 83.85%.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #362   +/-   ##
========================================
  Coverage    83.85%   83.85%           
========================================
  Files           24       24           
  Lines         8181     8181           
========================================
  Hits          6860     6860           
  Misses        1321     1321

Flag	Coverage Δ
c_api	`77.59% <ø> (ø)`
fortran_api	`56.14% <ø> (ø)`
python_api	`80.38% <ø> (ø)`
unit_tests	`1.24% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md

LecrisUT · 2024-01-19T19:27:43Z

README.md

+
+![License Status][license-badge]
+![CMake Status][cmake-badge]
+[![Python Versions][python-version]][pypi-link]


Python version badge will be fixed automatically in next pypi release

README.md

lan496 · 2024-01-19T23:54:48Z

@LecrisUT I've received "Request to install Codecov in spglib". Is it needed for the codecov badge? I remember this project is already integrated with codecov. What is the difference?

LecrisUT · 2024-01-19T23:59:19Z

@LecrisUT I've received "Request to install Codecov in spglib". Is it needed for the codecov badge? I remember this project is already integrated with codecov. What is the difference?

Can you get the badge api-token without installing codecov app? That's the main thing I'm trying with that.

lan496 · 2024-01-20T00:24:28Z

Do you need the badge api token as GitHub's Action secrets or raw string?

LecrisUT · 2024-01-20T00:28:22Z

Do you need the badge api token as GitHub's Action secrets or raw string?

Raw string, it's meant to be public and used in the README.md

lan496 · 2024-01-20T00:31:08Z

I see. Then, here it is.

[![codecov](https://codecov.io/gh/spglib/spglib/graph/badge.svg?token=G91xAWu1JT)](https://codecov.io/gh/spglib/spglib)

LecrisUT · 2024-01-20T13:25:23Z

All badges except for Python version are working. Just 2 things for this PR:

Feedback on namings:
- I am considering CI / 📘 docs / Sphinx-html instead, but would that be confusing?
- Would 🧪 be sufficient to indicate experimental jobs?
- + sign is excessive?
- Other suggestions for emojis?
When ready to merge, the pass job changed name a bit.

lan496 · 2024-01-24T10:17:20Z

Mask overall CI status on main branch

Can you explain this a little more? Are these badges reflected only on main branch?

lan496 · 2024-01-24T10:24:15Z

Feedback on namings:

I think the current emojis are nice!

LecrisUT · 2024-01-24T10:28:02Z

Mask overall CI status on main branch

Can you explain this a little more? Are these badges reflected only on main branch?

It's easiest with an example:
If you open the CI checks for this PR, you will see windows is failing, but the merge commit is showing it as passing. That is because I am masking the true result there so that on the main page the first commit is shown with a check mark.

README.md

lan496 · 2024-01-24T10:50:55Z

.github/workflows/step_test.yaml

-        toolchain: [ gcc, llvm, intel, windows, macos ]
-        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12"]
+        toolchain: [ gcc, llvm, intel ]
+        python-version: [ "3.8", "3.x" ]


Note: "3.x" specifies the latest stable version.
https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#using-the-python-version-input

lan496 · 2024-01-24T10:54:06Z

I see. Thanks, I've left a few comments.

lan496 · 2024-01-24T10:58:45Z

Add a static-analysis checker. I was experimenting with sonarcloud at CMake-Template repo. I think it could be useful to include it as an intermediate to clang-tidy. It is also polyglot, so it might pick up on more nieche problems

Is it included?

LecrisUT · 2024-01-24T11:06:16Z

Add a static-analysis checker. I was experimenting with sonarcloud at CMake-Template repo. I think it could be useful to include it as an intermediate to clang-tidy. It is also polyglot, so it might pick up on more nieche problems

Is it included?

Not yet, I will postpone it for after release #400

lan496 · 2024-01-24T23:27:57Z

README.md

+
+[ci-badge]: https://github.com/spglib/spglib/actions/workflows/ci.yaml/badge.svg?branch=develop&event=push
+[ci-link]: https://github.com/spglib/spglib/actions/workflows/ci.yaml?query=branch%3Adevelop+event%3Apush
+[cmake-badge]: https://img.shields.io/badge/CMake-3.15-blue?logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGRhdGEtbmFtZT0iTGF5ZXIgMiIgdmlld0JveD0iMCAwIDU0NS41IDU0NS45Ij48cGF0aCBkPSJNNTQ2IDUzNCAyODIgOWwzOSA0MzQgMjI1IDkxeiIgZGF0YS1uYW1lPSJyZWQgcmlnaHQiIHN0eWxlPSJmaWxsOiNmMzI3MzU7c3Ryb2tlLXdpZHRoOjAiLz48cGF0aCBkPSJNNTI1IDU0NiAxNzAgNDAzIDEgNTQ2aDUyNHoiIGRhdGEtbmFtZT0iZ3JlZW4gYm90dG9tIiBzdHlsZT0ic3Ryb2tlLXdpZHRoOjA7ZmlsbDojM2VhZTJiIi8+PHBhdGggZD0iTTI2MyAwIDAgNTIybDI4OC0yNDRMMjYzIDB6IiBkYXRhLW5hbWU9ImJsdWUgbGVmdCIgc3R5bGU9ImZpbGw6IzAwNjhjNztzdHJva2Utd2lkdGg6MCIvPjxwYXRoIGQ9Im0yOTEgMjk5LTEwNSA4OSAxMTcgNDgtMTItMTM3eiIgZGF0YS1uYW1lPSJncmF5IGNlbnRlciIgc3R5bGU9ImZpbGw6I2RjZTNlYztzdHJva2Utd2lkdGg6MCIvPjwvc3ZnPg==


Note: We have to manually update the badge for the CMake minimum version.

Yes, specifically only the 3.15 text and only when we bump minimum version

lan496 · 2024-01-25T10:38:53Z

@LecrisUT Can you address the branch conflicts?

Signed-off-by: Cristian Le <[email protected]>

Concurrency should be checked only on the top-level CI/caller Signed-off-by: Cristian Le <[email protected]>

Make the CI report more navigable Signed-off-by: Cristian Le <[email protected]>

Signed-off-by: Cristian Le <[email protected]>

- Reduce python tests: Only minimal + latest + future python version - Fix os toolchains Signed-off-by: Cristian Le <[email protected]>

Signed-off-by: Cristian Le <[email protected]>

LecrisUT · 2024-01-25T11:11:55Z

@LecrisUT Can you address the branch conflicts?

@lan496 Done. I forgot, you need to switch the required CI for the auto-merge

lan496 · 2024-01-25T11:51:44Z

Current branch rules

LecrisUT self-assigned this Nov 13, 2023

LecrisUT force-pushed the ci/organize branch 2 times, most recently from 737a0ae to e7c6073 Compare November 14, 2023 10:53

LecrisUT force-pushed the ci/organize branch from e7c6073 to cf4ec58 Compare January 19, 2024 19:15

LecrisUT changed the title ~~ci: Cleanup CI~~ ci: Reorganize CI Jan 19, 2024

LecrisUT force-pushed the ci/organize branch from cf4ec58 to 976746d Compare January 19, 2024 19:20

LecrisUT commented Jan 19, 2024

View reviewed changes

LecrisUT force-pushed the ci/organize branch from 976746d to c8d0770 Compare January 19, 2024 19:38

LecrisUT mentioned this pull request Jan 19, 2024

feat: Refactor CMake project #397

Merged

LecrisUT force-pushed the ci/organize branch 3 times, most recently from e186729 to b749111 Compare January 20, 2024 01:17

LecrisUT marked this pull request as ready for review January 20, 2024 11:29

LecrisUT force-pushed the ci/organize branch 6 times, most recently from 5d81a44 to 67261a4 Compare January 20, 2024 13:21

LecrisUT requested review from atztogo and lan496 January 20, 2024 13:26

LecrisUT assigned lan496 and unassigned LecrisUT Jan 20, 2024

lan496 reviewed Jan 24, 2024

View reviewed changes

LecrisUT mentioned this pull request Jan 24, 2024

Add a static-analysis checker #400

Open

LecrisUT force-pushed the ci/organize branch from eb0bc85 to 5cc5eb5 Compare January 24, 2024 12:28

lan496 reviewed Jan 24, 2024

View reviewed changes

lan496 approved these changes Jan 24, 2024

View reviewed changes

atztogo approved these changes Jan 25, 2024

View reviewed changes

LecrisUT and others added 8 commits January 25, 2024 11:40

Separate pre-commit step

bf6b529

Signed-off-by: Cristian Le <[email protected]>

fix concurrency references

dd6fb21

Concurrency should be checked only on the top-level CI/caller Signed-off-by: Cristian Le <[email protected]>

Simplify CI names

a2927c3

Make the CI report more navigable Signed-off-by: Cristian Le <[email protected]>

Separate coverage step

3f88252

Signed-off-by: Cristian Le <[email protected]>

Mask experimental runs

7e8f5d2

Signed-off-by: Cristian Le <[email protected]>

Badges!

90196bb

Signed-off-by: Cristian Le <[email protected]>

Change step_test matrix

aa56b28

- Reduce python tests: Only minimal + latest + future python version - Fix os toolchains Signed-off-by: Cristian Le <[email protected]>

Disable windows-2019 and python --pre to be investigated later

045c479

Signed-off-by: Cristian Le <[email protected]>

LecrisUT force-pushed the ci/organize branch from 5cc5eb5 to 045c479 Compare January 25, 2024 10:41

LecrisUT enabled auto-merge January 25, 2024 10:44

lan496 disabled auto-merge January 25, 2024 11:48

lan496 merged commit ddbdd40 into spglib:develop Jan 25, 2024

LecrisUT deleted the ci/organize branch January 25, 2024 14:03

LecrisUT added this to the 2.3 milestone Jan 25, 2024

chenrui333 mentioned this pull request Jan 28, 2024

spglib 2.3.0 Homebrew/homebrew-core#161138

Merged

Conversation

LecrisUT commented Nov 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Nov 14, 2023 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

LecrisUT Jan 19, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

lan496 commented Jan 19, 2024

Uh oh!

LecrisUT commented Jan 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lan496 commented Jan 20, 2024

Uh oh!

LecrisUT commented Jan 20, 2024

Uh oh!

lan496 commented Jan 20, 2024

Uh oh!

LecrisUT commented Jan 20, 2024

Uh oh!

lan496 commented Jan 24, 2024

Uh oh!

lan496 commented Jan 24, 2024

Uh oh!

LecrisUT commented Jan 24, 2024

Uh oh!

Uh oh!

lan496 Jan 24, 2024

Choose a reason for hiding this comment

Uh oh!

lan496 commented Jan 24, 2024

Uh oh!

lan496 commented Jan 24, 2024

Uh oh!

LecrisUT commented Jan 24, 2024

Uh oh!

lan496 Jan 24, 2024

Choose a reason for hiding this comment

Uh oh!

LecrisUT Jan 25, 2024

Choose a reason for hiding this comment

Uh oh!

lan496 commented Jan 25, 2024

Uh oh!

LecrisUT commented Jan 25, 2024

Uh oh!

lan496 commented Jan 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

LecrisUT commented Nov 13, 2023 •

edited

Loading

codecov-commenter commented Nov 14, 2023 •

edited by codecov bot

Loading

LecrisUT commented Jan 19, 2024 •

edited

Loading