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

Start to keep Architectural Decision Records (ADRs) for tuf reference implementation #1182

Merged
merged 4 commits into from
Oct 27, 2020

Conversation

joshuagl
Copy link
Member

Fixes #1141, #1125

Description of the changes being introduced by the pull request:

Add initial Architectural Decision Records (ADRs) documenting some workflow decisions before the refactor:

  1. Use of MADR format to keep ADRs for the reference implementation
  2. Decision to adopt Python 3.6+ moving forward (dropping Python 2.7)

Please verify and check that the pull request fulfills the following
requirements
:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

@joshuagl
Copy link
Member Author

I'm not sure why the AppVeyor build is failing to find dateutil when other recent builds have successfully run the same tests which are now failing, i.e. AppVeyor run for the 0.15.0 release PR #1183 is green while this one is red

@jku
Copy link
Member

jku commented Oct 21, 2020

I'm not sure why the AppVeyor build is failing to find dateutil when other recent builds have successfully run the same tests which are now failing, i.e. AppVeyor run for the 0.15.0 release PR #1183 is green while this one is red

The securesystemslib release probably has something to do with it?

@joshuagl
Copy link
Member Author

I'm not sure why the AppVeyor build is failing to find dateutil when other recent builds have successfully run the same tests which are now failing, i.e. AppVeyor run for the 0.15.0 release PR #1183 is green while this one is red

The securesystemslib release probably has something to do with it?

I think you're right! We did remove python-dateutil as a dependency of securesystemslib.

Copy link
Contributor

@mnm678 mnm678 left a comment

Choose a reason for hiding this comment

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

These look great. Once the AppVeyor issue is resolved I think it's good to go.

In order to make decisions about the code and the design explicit and easier
to reference in future we want to record significant architectural decisions.

This commit introduces docs/adr with a template Architectural Decision Record
and index using the [MADR](https://adr.github.io/madr/) format.

It also adds ADR 0000 to document the decisions to use MADR.

Fixes theupdateframework#1141

Signed-off-by: Joshua Lock <[email protected]>
Document the decision drop support for EOL Python versions, most notable
Python 2.7

Fixes theupdateframework#1125

Signed-off-by: Joshua Lock <[email protected]>
Provide additional context to clarify where we expect Python 3.6+ to be used
exclusively (new modules) and link to other discussions around the future of
Python 2.7 supporting code.

Signed-off-by: Joshua Lock <[email protected]>
Copy link
Member

@lukpueh lukpueh left a comment

Choose a reason for hiding this comment

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

Mille grazie, @joshuagl!

@lukpueh lukpueh merged commit 9908f8e into theupdateframework:develop Oct 27, 2020
@joshuagl joshuagl deleted the joshuagl/adrs branch October 27, 2020 11:32
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.

Keep track of procedural and architectural decision
5 participants