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

copy workflows from blueapi, [still need to configure env values -not a code change] #664

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

stan-dot
Copy link
Contributor

@

@stan-dot stan-dot added enhancement New feature or request github_actions Pull requests that update GitHub Actions code labels Nov 21, 2024
@stan-dot stan-dot requested a review from coretl November 21, 2024 16:51
@stan-dot stan-dot self-assigned this Nov 21, 2024
@stan-dot stan-dot linked an issue Nov 21, 2024 that may be closed by this pull request
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@stan-dot stan-dot force-pushed the 662-add-codeql-and-sonarcloud-steps-to-the-ci branch from 8562d66 to 5f9ea2e Compare November 25, 2024 15:36
@stan-dot stan-dot marked this pull request as ready for review December 6, 2024 15:01
Copy link
Collaborator

@coretl coretl left a comment

Choose a reason for hiding this comment

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

Please can you:

  • compress codeql.yaml down so that it only contains the python bits
  • turn it into a reusable workflow like _tox.yaml and call it from periodic.yaml
  • delete sonarcloud things

@stan-dot stan-dot force-pushed the 662-add-codeql-and-sonarcloud-steps-to-the-ci branch from 959cad1 to cfe48a3 Compare December 11, 2024 10:45
@stan-dot
Copy link
Contributor Author

thanks for the comments @coretl . I deleted the 'if swift language' branches, kept the comments though to keep this more similar to the template workflow for codeql. now sure fully about the syntax in the periodic file though

Copy link
Collaborator

Choose a reason for hiding this comment

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

Please delete

Comment on lines 79 to 82
# If the analyze step fails for one of the languages you are analyzing with
# "We were unable to automatically build your code", modify the matrix above
# to set the build mode to "manual" for that language. Then modify this step
# to build your code.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please remove comments that are not relevant and this manual mode

Copy link
Contributor Author

Choose a reason for hiding this comment

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

addressed

Comment on lines +11 to +14
secrets:
codeql_token:
description: "Token for CodeQL"
required: true
Copy link
Collaborator

Choose a reason for hiding this comment

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

Where is this token used? Isn't it just the GH token?


jobs:
analyze:
name: Analyze (${{ matrix.language }})
Copy link
Collaborator

Choose a reason for hiding this comment

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

matrix?

Comment on lines +50 to +51
languages: ${{ matrix.language }}
build-mode: ${{ matrix.build-mode }}
Copy link
Collaborator

Choose a reason for hiding this comment

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

matrix?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

and we have the strategy using matrix on lines 34...

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ok, but as there is a single entry in the matrix I suggest you remove it and put the variables here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this was the template provided, isn't just simpler to keep it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Personal preference. My opinion is that people will read the code a lot more often than write the code. The template's job is to tell us how to make a maximally complicated example work. Our job is to take the bits we want out of it and make an understandable blob of YAML that reads legibly. I would suggest removing the single item matrix as it gets in the way of doing this.

Comment on lines +16 to +17
with:
codeql: "Check codeql setup"
Copy link
Collaborator

Choose a reason for hiding this comment

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

No with: required

Comment on lines +6 to +10
codeql:
description: "Specify the trigger type"
required: true
type: string
default: "push"
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not used either

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CodeQL and Sonarcloud steps to the CI
2 participants