Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix CI Pipeline Issues #84

Open
wants to merge 9 commits into
base: release-2.1
Choose a base branch
from
Open

Conversation

irby
Copy link

@irby irby commented Feb 19, 2025

This PR serves as a initial change set for a 2.1 release. Currently, the CI pipeline has some issues that this PR will help resolve. Additionally, it includes some documentation updates that were incorporated into the e2e-tutorial branch but were never merged in.

Fixes to the CI process:

  • Using version v3 of the release workflow instead of ejbca-readme-updates. Fixes an issue when compiling docsource.
  • Fixes Go lint issues that occurred when using a more recent version of the golangci-lint tool.

Updates to the CI process:

  • Lock in the golangci-lint tool to a specific version (1.64.5) instead of latest. This will ensure newer versions of the tool do not break the CI process.

Additional updates:

  • Documentation changes that were cherry picked from e2e-tutorial
  • Use require.Contains instead of require.True, the benefit of using this is that if the assertion fails it prints out expected vs received, helpful for troubleshooting breaking changes in the tests.

@@ -152,5 +152,5 @@ func (s *signer) parseEjbcaError(ctx context.Context, detail string, err error)

logger.Error(err, "EJBCA returned an error")

return fmt.Errorf(errString)
return fmt.Errorf("%s", errString)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolves an error generated by golangci-lint.

@@ -2,11 +2,11 @@ run:
# timeout for analysis, e.g. 30s, 5m, default is 1m
timeout: 12m

skip-dirs:
issues:
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Resolves two warnings generated by golangci-lint.

@@ -30,7 +30,7 @@ jobs:
- name: Run linters
uses: golangci/golangci-lint-action@3a919529898de77ec3da873e3063ca4b10e7f5cc # v3.7.0
with:
version: latest
version: v1.64.5
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Locking in specific version of this tool should mitigate breaking changes in newer versions of the lint tool.

@irby irby added the github_actions Pull requests that update GitHub Actions code label Feb 19, 2025
@irby irby changed the title Chore/67229/fix go lint issue Fix CI Pipeline Issues Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants