Set up CI for the project #26

Manually merged

BaumiCoder merged 114 commits from chore/10-CI into main 2025-10-19 19:31:08 +02:00

Conversation 1 Commits 114 Files changed 12 +476 -7

BaumiCoder commented 2025-10-04 16:20:42 +02:00

Owner

Copy link

Resolves #10

User perspective

You will find for each finalized version of ecformat a Release, which links to the related pull requests (as kind of changelog), the ecformat_bin package on Codeberg with compiled binaries of some common platforms and further package formats, when they will be available in future versions (see related issues).

Developer perspective

The CI will now, do the following:

• On Pull request (opening / pushing changes to an open one)
  • NO explicit build, as the linters (like Clippy) or the tests already include a compilation
  • Run linters for which respected files have changed (e.g., yamllint only if YAML file has changed)
  • Run all tests if Rust code or relevant config has changed (e.g., do not run if only linter config has changed)
• On Tagging (pushing a v* tag)
  • Validate that all issues in the milestone are closed and the version in the Cargo.toml matches with the tag naming.
  • Execute respective linters
  • Run all tests
  • Check that it compiles for all targets and features
  • Build for several platforms & upload them to the ecformat_bin package
  • Create a release on Codeberg
  • (In the future: create and upload further package formats)
  • Close the milestone of the version

Up-to-date details about the release parts in the Development.md file.

Resolves #10 ### User perspective You will find for each finalized version of ecformat a [Release](https://codeberg.org/BaumiCoder/ecformat/releases), which links to the related pull requests (as kind of changelog), the `ecformat_bin` package on Codeberg with compiled binaries of some common platforms and further package formats, when they will be available in future versions (see [related issues](https://codeberg.org/BaumiCoder/ecformat/issues?q=&type=all&sort=&state=all&labels=588082&milestone=0&project=0&assignee=0&poster=0&archived=false)). ### Developer perspective The CI will now, do the following: - On Pull request (opening / pushing changes to an open one) - NO explicit build, as the linters (like Clippy) or the tests already include a compilation - Run linters for which respected files have changed (e.g., `yamllint` only if YAML file has changed) - Run all tests if Rust code or relevant config has changed (e.g., do not run if only linter config has changed) - On Tagging (pushing a `v*` tag) - Validate that all issues in the milestone are closed and the version in the `Cargo.toml` matches with the tag naming. - Execute respective linters - Run all tests - Check that it compiles for all targets and features - Build for several platforms & upload them to the `ecformat_bin` package - Create a release on Codeberg - (In the future: create and upload further package formats) - Close the milestone of the version Up-to-date details about the release parts in the `Development.md` file.

BaumiCoder added this to the Version 0.1.0 milestone 2025-10-04 16:20:42 +02:00

BaumiCoder added the

Kind

Chore

label 2025-10-04 16:20:42 +02:00

BaumiCoder self-assigned this 2025-10-04 16:20:45 +02:00

BaumiCoder added 1 commit 2025-10-04 16:20:45 +02:00

Add test action a91551a211

BaumiCoder added 1 commit 2025-10-04 16:32:14 +02:00

Fix checkout ... 5dab43b9f5

Node is missing in the rust image

BaumiCoder added 1 commit 2025-10-04 16:52:01 +02:00

Use image with Node integrated ... 59c12c5940

setup-node fails with
"Error: crun: executable file `node` not found in $PATH:
No such file or directory: OCI runtime attempted to invoke a command
that was not found"
--> node-setup needs node to be executed?

BaumiCoder added 1 commit 2025-10-04 17:58:14 +02:00

Add lint action beee4ae638

BaumiCoder added 1 commit 2025-10-04 18:02:57 +02:00

Fix action name e95d0a5ba3

BaumiCoder added 1 commit 2025-10-05 10:57:47 +02:00

Lint action(s) without pre-commit ... ad028cd3a8

The installations for the hook environment has a time out at 4m50s.
Therefore, switch to single actions for the different linters.

BaumiCoder added 5 commits 2025-10-05 11:44:18 +02:00

Longer runtime for actions with build ... d67b287409

The build of rust projects is part of some action
and these take some time.

Correct taplo-cli version 44ee2ec902

Add codespell action ... 7a17cc073a

The GitHub action from the codespell project at
https://github.com/codespell-project/actions-codespell
was not updated for over a year. Therefore, better install it with pip.

Add yamllint action ... 0195ceecf4

No maintainted action found. Therefore, better install it with pip.

Add REUSE action ... 74f29f13e6

Using the official GitHub action as it is maintained.
Restrict version to the major version only as the action
is also only restricted to major version.

BaumiCoder added 4 commits 2025-10-06 09:47:49 +02:00

Add cargo / rust caching to actions ... e4b44e8a37

Even the time out limit of 4 minutes is not enought for the most
rust buildes. Maybe the caching action helps.

Cargo config to decrease build time 2a2e9824f6

Use binaries instead of compiling rust code ... f2a012fd66

The actions for these tools, written in rust, uses the binaries
from the GitHub releases. Therefore, it should be faster than a
cargo install, which builds the the project.

Fixing action URL babdc5e7a3

BaumiCoder added 1 commit 2025-10-06 16:46:50 +02:00

Switch server for forgejo runner ... 4906598ee1

Using my newly created forgejo runner on my homeserver

BaumiCoder added 2 commits 2025-10-06 17:27:33 +02:00

Adjust rust version handling ... c00ef7c719

No not fix patch version and use rust-toolchain.toml to fix it also for
the local development. Furthermore, use the GitHub Action Rust image,
which is more similar to the default image (from GitHub Actions)
and with rustup this automatically uses the rust version from the toml.

Fix yamllint action 7c69cc6178

BaumiCoder added 2 commits 2025-10-06 17:58:07 +02:00

Add Action linter ... ab4a778629

No need to run this in an Action as they will fail if the Action yaml
files are incorrect in anyway.

Fix order for rust cache ... 1160c2b637

The rust cache action fails as it cannot find a Cargo.toml.
Therefore, the chechout have to be done before the cache action.

BaumiCoder added 3 commits 2025-10-07 10:45:12 +02:00

Share rust cache between action ... 2becf86e9a

All three actions needs the compiled dependencies of ecformat

Remove redundant rust version config ... ac6aae8304

Running cargo deny inside the repository uses the rust-toolchain.toml.
Output of the action:
info: profile set to 'minimal'
info: syncing channel updates for '1.90-x86_64-unknown-linux-musl'
info: latest update on 2025-09-18, rust version 1.90.0 (1159e78c4 2025-09-14)
info: downloading component 'cargo'
info: downloading component 'rust-std'
info: downloading component 'rustc'
info: installing component 'cargo'
info: installing component 'rust-std'
info: installing component 'rustc'
info: default toolchain set to '1.90-x86_64-unknown-linux-musl'
  1.90-x86_64-unknown-linux-musl installed - rustc 1.90.0 (1159e78c4 2025-09-14)
info: note that the toolchain '1.90-x86_64-unknown-linux-musl' is currently in use (overridden by '/workspace/BaumiCoder/ecformat/rust-toolchain.toml')
Default host: x86_64-unknown-linux-musl

Use rust cache in all actions with cargo ... f682b5acb2

At least the installed rust version can be used from a common cache,
but do not use the big cache with all ecformat dependencies as they
are not necessary in these actions and would increase the duration
for loading the (bigger) cache.

BaumiCoder added 2 commits 2025-10-07 13:58:32 +02:00

Use locked versions in actions 8c8f4b515f

Add release action 42e832893a

BaumiCoder added 1 commit 2025-10-08 16:08:12 +02:00

Specify shell for multi-command steps ... c795523ff4

In steps with multiple commands, especially if control structures
like case are used, the syntax dependence on the used shell.

BaumiCoder added 4 commits 2025-10-08 17:49:24 +02:00

Add cargo-udeps action ... dd8a05ad5f

There is no maintained action for this on GitHub and downloading the
binary for a rough version (0.1.*) is not trivial. Therefore,
use cargo install and the rust cache action.

Same runner for all actions ... f18e92e72b

One job still had a codeberg runner

Run toml and yaml linter only if necessary d856d7e871

Fix typo 4453372921

BaumiCoder added 6 commits 2025-10-08 18:52:18 +02:00

Fix URL for paths-filter action 02feb959ba

Run cargo linters only if necessary ... 5b57fa19c9

Do not filter udeps yet, as it has not be successfully tested yet.

Fix udeps action 8407528041

Do not run cargo-deny if only rust code changes ... 613b220a89

cargo-deny is a linter for dependencies and these cannot change
only with changes in rust code of the project.

codespell: Include hidden files ... dc5fa5653a

Detected that hidden files are not considered by codespell,
because the action has no exclude for the .schemata directory and
does not fail due to spelling mistakes there.
Using a config file to avoid duplications between pre-commit and action
configuration.

Fix case branches in action step ... fcc712991f

Aach branch in a bash case needs to end with ";;"

BaumiCoder added 2 commits 2025-10-09 09:49:10 +02:00

Fail action if package upload fails ... 511989ad7c

The exit code of curl does not indicate an http error by default.
The last run has not created a package an the action has the message
"reqPackageAccess" in the output.

Use an extra token for package upload ... da6a4167aa

The FORGEJO_TOKEN, which is automatically available for every action,
seems to have to less permissions to upload a package.

BaumiCoder added 2 commits 2025-10-09 11:05:21 +02:00

Log out put for package upload action ... 8b45f900d2

The action fails with http 400 but the same curl command works locally.

Run cargo-udeps action only if necessary ... a644586789

Test executions completed (also a second one to test the cache usage)
and now only run if relevant files had changed (same as in pre-commit).

BaumiCoder added 3 commits 2025-10-09 14:49:12 +02:00

Further debugging of package upload ... ad5b5d7623

Still not working in the action, but the curl command works locally.
Maybe the file is not in place or the URL is not build correctly?

Run tests also before release ... 76a782da7b

Adding a local action for test execution to reduce duplicated code
(only the actions inside a workflow can depend on each other).

Run tests on PR only if necessary 1f80da833f

BaumiCoder added 2 commits 2025-10-09 15:32:30 +02:00

Fix file extension of action 703b7f46fd

Peform checkout before using local action ... 98ddb13b58

Without the repository being checked out,
the local action (the action.yaml) is also not available.

BaumiCoder added 1 commit 2025-10-09 16:24:41 +02:00

Fix package name in release action ... f0cc7677ca

Assigning a * does not expend it, but using it in a echo command
expend it to the matching file.

BaumiCoder added 2 commits 2025-10-09 18:53:48 +02:00

Rename package ... 4a7cf9e17f

I think, I will use the packages on codeberg also for the other
package formats as an alternative to central package repositories.
Therefore, a more unique name is necessary.

Add action for lelease information 9ed26a805f

BaumiCoder added 3 commits 2025-10-10 09:14:07 +02:00

Add missing URL to release info action 23636d02c4

Switch to AuthorizationHeaderToken for Forgejo API ... d8b50513d9

This seems to be the recommended way when using tokens.

Speed up test iterations ... 0b0349d8ad

Exclude some targets to get faster feedback for changes in the workflow

BaumiCoder added 1 commit 2025-10-10 09:57:02 +02:00

Set API version ... 2257c93403

The swagger page from Codeberg says that /api/v1 is the base URL.

BaumiCoder added 1 commit 2025-10-10 10:33:23 +02:00

Package endpoint not found at v1 API ... cda2e54989

This endpoint is also missing on the swagger page ...

BaumiCoder added 1 commit 2025-10-10 11:25:34 +02:00

Quote JSON fields ... e22bcb801c

The action fails with
"invalid character 't' looking for beginning of object key string"

BaumiCoder added 3 commits 2025-10-10 13:07:11 +02:00

Fix URL formatting in Release body ... 6ad86a64a1

There was a white space between the "]" and the "(" with the previous
implementation. Extract the URLs into variables to have the whole
[...](...) schema in one line, without having too long lines.

Consider tag name and crate version for release ef25fb228a

Consider milestone for release 1277a9bfbf

BaumiCoder added 1 commit 2025-10-10 16:00:32 +02:00

Add log output for milestone validation ... 1cb904eea6

This steps failed with

jq: error (at <stdin>:1): Cannot index string with string "open_issues"
parse error: Invalid numeric literal at line 1, column 7

BaumiCoder added 1 commit 2025-10-10 16:22:31 +02:00

Fix quotation error 5b3de8fd75

BaumiCoder added 3 commits 2025-10-10 17:40:25 +02:00

HTTP get in release: Fix header ca5a4b6d06

Update milestone in release info action ab8eb6228c

Add tag message to release description with action 6f0a1a1af6

BaumiCoder added 1 commit 2025-10-11 09:35:25 +02:00

Mask line break in script 5356a4cd4f

BaumiCoder added 1 commit 2025-10-11 10:27:21 +02:00

Checkout repository to read tag message in action ... 22c7c99a7b

fatal: not a git repository
(or any parent up to mount point /workspace/BaumiCoder)

BaumiCoder added 1 commit 2025-10-11 11:16:55 +02:00

Log output for release body ... fb2152c7a5

The release cannot be created in the CI with error message:
{"message":"[]: invalid character '\\n' in string literal",
"url":"https://codeberg.org/api/swagger"}

I works in my local bash. What unexpected content is the the BODY?

BaumiCoder added 2 commits 2025-10-11 12:22:30 +02:00

Handle line breaks in tag message 7fa56301e9

Log output for tag message ... 69baf83d1b

In the CI the command seems to give the commit message of the tagged
commit and not the tag message. Why?

BaumiCoder added 1 commit 2025-10-11 14:15:08 +02:00

Fix shell syntax error ... b8dbca1d03

line 6: syntax error near unexpected token `('

BaumiCoder added 3 commits 2025-10-11 16:02:51 +02:00

Log output for milestone data ... 963f1b6a25

The returned json is not tested locally as the action fails with:
jq: error (at <stdin>:1): Cannot index array with string "description"

Further tag message logging ... 7df4f61827

The same command in the same container image shows me the tag message
on my machine, but in the CI it is the commit message ...?

Remove hardcoded URLs 2a86f7c3da

BaumiCoder commented 2025-10-11 16:49:28 +02:00

Author

Owner

Copy link

Close temporary to reduce CI executions

Close temporary to reduce CI executions

BaumiCoder closed this pull request 2025-10-11 16:49:29 +02:00

BaumiCoder reopened this pull request 2025-10-19 18:56:36 +02:00

BaumiCoder added 2 commits 2025-10-19 19:15:37 +02:00

Fix typo 24dfce205e

README: Add hyperlink to release badge 92012b9d68

BaumiCoder changed title from WIP: Set up CI for the project to Set up CI for the project 2025-10-19 19:19:05 +02:00

BaumiCoder referenced this pull request from a commit 2025-10-19 19:31:05 +02:00

Merge branch 'chore/10-CI'

BaumiCoder manually merged commit 59ffa96e9b into main 2025-10-19 19:31:08 +02:00

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

Compat/Breaking

Breaking change that won't be backward compatible

  

EditorConfig

0.17.2

Issues to support version 0.17.2 of the EditorConfig specification

  

Kind

Bug

Something is not working

  

Kind

Chore

Some tasks maintainig tasks

  

Kind

Documentation

Documentation changes

  

Kind

Enhancement

Improve existing functionality

  

Kind

Feature

New functionality

  

Kind

Testing

Issue or pull request related to testing

  

Packaging

About packaging the project for some platform

  

Priority

Critical

The priority is critical

  

Priority

High

The priority is high

  

Priority

Low

The priority is low

  

Priority

Medium

The priority is medium

  

Reviewed

Confirmed

Issue has been confirmed

  

Reviewed

Duplicate

This issue or pull request already exists

  

Reviewed

Invalid

Invalid issue

  

Reviewed

Won't Fix

This issue won't be fixed

  

Status

Abandoned

Somebody has started to work on this but abandoned work

  

Status

Blocked

Something is blocking this issue or pull request

  

Status

Need More Info

Feedback is required to reproduce issue or to continue work

  

WIP

Work in progress (Assignee is working on this issue)

No labels

Compat/Breaking

EditorConfig

0.17.2

Kind

Bug

Kind

Chore

Kind

Documentation

Kind

Enhancement

Kind

Feature

Kind

Testing

Packaging

Priority

Critical

Priority

High

Priority

Low

Priority

Medium

Reviewed

Confirmed

Reviewed

Duplicate

Reviewed

Invalid

Reviewed

Won't Fix

Status

Abandoned

Status

Blocked

Status

Need More Info

WIP

Milestone

Clear milestone

No items

No milestone

Version 0.1.0

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

BaumiCoder

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

BaumiCoder/ecformat!26

No description provided.