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 developer docs for CI debugging #113

Merged
merged 2 commits into from
Jan 5, 2021
Merged

Add developer docs for CI debugging #113

merged 2 commits into from
Jan 5, 2021

Conversation

emkll
Copy link
Contributor

@emkll emkll commented Nov 27, 2020

Status

Ready for review

Description of Changes

  • Description:

Provides instructions for developers to debug the CI instances, by connecting to the, through the CircleCI container.

Testing

Since these are only dev-facing, they should be good to merge if they are understandable. The reviewer can also use the existing branch and restart with ssh on https://github.com/freedomofpress/securedrop/compare/test-apparmor-ci to test

Checklist (Optional)

  • Doc linting (make docs-lint) passed locally
  • Doc link linting (make docs-linkcheck) passed
  • You have previewed (make docs) docs at http://localhost:8000

Cloud instances are deleted after the test run is completed, whether a test run
passes or fails. In order to debug the state of the remote instance, we must first
ensure that the instance is not automatically destroyed. Note that there is a also
a cron job that destroys instances daily as well. The following is an example
Copy link
Contributor

Choose a reason for hiding this comment

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

slight nit: "there is a also a cron job" -> there is also a cron job

molecule "${MOLECULE_ACTION:-converge}" -s "${securedrop_staging_scenario}" "${EXTRA_ANSIBLE_ARGS[@]}"
fi

Once that commit is pushed, run the appropritate ``staging-test-with-rebase`` job
Copy link
Contributor

Choose a reason for hiding this comment

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

appropritate -> appropriate

Copy link
Contributor

@kushaldas kushaldas left a comment

Choose a reason for hiding this comment

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

This is good, and approved.

May be in future we should add a section explaining who all (not names, somehow define) has access to the CI for the same.

@kushaldas kushaldas merged commit 22fe7a4 into main Jan 5, 2021
@legoktm legoktm deleted the ci-docs-debug branch May 28, 2024 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants