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

docs: document other env vars for make test-acc #1433

Merged
merged 1 commit into from
Nov 8, 2023

Conversation

sigmaris
Copy link
Member

@sigmaris sigmaris commented Nov 7, 2023

About this change—what it does

Improves documentation of the environment variables that are used or influence the running of the acceptance tests.

Why this way

Fully running the acceptance tests uses more than just a project, there are tests which interact with accounts and orgs, and it took some questioning on Slack and searching the source code to figure out how to properly run these tests locally and against a dev environment, so we should probably document how to get them to run here to save future engineers time.

@sigmaris sigmaris requested a review from a team November 7, 2023 15:43
@sigmaris sigmaris force-pushed the sigmaris-improve-docs-somewhat branch 2 times, most recently from d39c58e to 5cf5a50 Compare November 7, 2023 16:03
CONTRIBUTING.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@sigmaris sigmaris force-pushed the sigmaris-improve-docs-somewhat branch from 5cf5a50 to 86937f0 Compare November 8, 2023 09:47
@sigmaris
Copy link
Member Author

sigmaris commented Nov 8, 2023

The semgrep action also seems broken, though unrelated to this change.

@Serpentiel
Copy link
Contributor

The semgrep action also seems broken, though unrelated to this change.

I'm currently working on it :)

@Serpentiel Serpentiel added the no changelog No changelog entries are required for this PR label Nov 8, 2023
@Serpentiel Serpentiel self-assigned this Nov 8, 2023
@sigmaris sigmaris force-pushed the sigmaris-improve-docs-somewhat branch from 86937f0 to 7ed094b Compare November 8, 2023 10:01
@Serpentiel Serpentiel added the documentation Improvements or additions to documentation label Nov 8, 2023
@sigmaris sigmaris dismissed Serpentiel’s stale review November 8, 2023 10:12

Made requested changes.

Fully running the acceptance tests uses more than just a project, there
are tests which interact with accounts and orgs, so we should probably
document how to get them to run here.
@Serpentiel Serpentiel force-pushed the sigmaris-improve-docs-somewhat branch from 7ed094b to f323637 Compare November 8, 2023 12:56
Copy link
Contributor

@Serpentiel Serpentiel left a comment

Choose a reason for hiding this comment

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

lgtm

@Serpentiel Serpentiel enabled auto-merge (squash) November 8, 2023 12:56
@Serpentiel Serpentiel merged commit 0fcfd29 into main Nov 8, 2023
9 checks passed
@Serpentiel Serpentiel deleted the sigmaris-improve-docs-somewhat branch November 8, 2023 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation no changelog No changelog entries are required for this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants