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

bootstrap repository setup #1

Merged
merged 10 commits into from
Jul 17, 2024
Merged

bootstrap repository setup #1

merged 10 commits into from
Jul 17, 2024

Conversation

aajtodd
Copy link
Contributor

@aajtodd aajtodd commented Jul 16, 2024

Description of changes:

Adds basic repository setup (README, CODEOWNERS, basic CI, gitignore, etc).

NOTE: I have bootstrapped the main branch with the existing commits from awslabs/smithy-rs@s3-tm-main already.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

# Ignore `trybuild` errors as they are irrelevant and flaky on nightly
TRYBUILD: overwrite

semver:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We may want to disable/remove this until we actually publish as it will fail until then (it's not marked as a required check currently though)

contents: read

jobs:
# depens on all actions required for a "successful" CI run
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# depens on all actions required for a "successful" CI run
# depends on all actions required for a "successful" CI run


- name: test s3-transfer-manager HLL
run: |
set -euxo pipefail
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought these settings happened by default in github workflows?

Comment on lines 66 to 68
- ubuntu-latest
- windows-latest
- macos-latest
Copy link
Contributor

Choose a reason for hiding this comment

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

To avoid CI unexpectedly breaking, I prefer to use specific versions of the runners (example: awslabs/aws-crt-ruby#61). I don't know a good short comment to indicate "this was latest when I authored this, feel free to update"

Suggested change
- ubuntu-latest
- windows-latest
- macos-latest
runs-on: ubuntu-24.04

I'm fine using "latest" for stuff where you really want to know when your stuff breaks against latest (e.g. Rust version). But a new version of ubuntu isn't usually that kind of thing

@@ -0,0 +1,270 @@
on:
pull_request:
Copy link
Contributor

Choose a reason for hiding this comment

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

this means CI won't run unless we've OK'd every single commit from external forks, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That is a setting at the repository level not in individual workflows but yes that is under our control.

uses: dtolnay/rust-toolchain@stable
with:
toolchain: ${{ env.rust_stable }}
- name: Install cargo-nextest

Choose a reason for hiding this comment

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

👍

cargo nextest run --workspace --all-features
cargo test --doc --workspace --all-features

fmt:

Choose a reason for hiding this comment

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

Does it help lead to better dev experience if we eventually catch complaints from fmt or clippy prior to opening a PR, e.g. pre-commit-hooks?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah we can add those precommit hooks in a follow up PR, I just wanted to be sure we get them checked and this was easy to add with the rest of CI.

@aajtodd aajtodd merged commit 78f3a44 into main Jul 17, 2024
14 of 15 checks passed
@aajtodd aajtodd deleted the bootstrap-repo branch July 17, 2024 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.

3 participants