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

add 'enabled' flag for Build Scans #3459

Merged
merged 4 commits into from
Jan 23, 2024
Merged

Conversation

adam-enko
Copy link
Member

@adam-enko adam-enko commented Jan 22, 2024

I want to opt GitHub into the Build Scans by default. Currently that's done by adding the build scan URL variable, which in GitHub would be done by adding an environment variable ORG_GRADLE_PROJECT_org.jetbrains.dokka.build.scan.url=https://ge.jetbrains.com/.

But GitHub can't have default environment variables with dots . in them, so defining the build scan server URL in all actions would have to be manually done for each GitHub action. That's annoying and is work to maintain.

Instead, this PR adds a 'build.scan.enabled' flag that defaults to 'true' on CI.

Additionally, some minor tweaks:

  • fix overridden name not overriding.
  • add username for GitHub Actions

GitHub can't have default environment variables with dots `.` in them, so defining the
build scan server URL in all actions would have to be manually done for each GitHub
action. That's annoying and is work to maintain.

Instead, this PR adds a 'build.scan.enabled' flag that defaults to 'true' on CI.
@adam-enko adam-enko self-assigned this Jan 22, 2024
@adam-enko adam-enko added the infrastructure Everything related to builds tools, CI configurations and project tooling label Jan 22, 2024
@adam-enko adam-enko merged commit 1e13237 into master Jan 23, 2024
11 of 12 checks passed
@adam-enko adam-enko deleted the fix/build-scan-enable-flag branch January 23, 2024 10:04
vmishenev pushed a commit that referenced this pull request Mar 20, 2024
* add 'enabled' flag for Build Scans

GitHub can't have default environment variables with dots `.` in them, so defining the
build scan server URL in all actions would have to be manually done for each GitHub
action. That's annoying and is work to maintain.

Instead, this PR adds a 'build.scan.enabled' flag that defaults to 'true' on CI.

* fix overridden name not overriding

* give GitHub Build Scans a 'GitHub' name

* remove old comment about buildScanUrl opt out
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Everything related to builds tools, CI configurations and project tooling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants