From b214cdbbf0855b2c56e7e84803c1698d9a87c6bb Mon Sep 17 00:00:00 2001 From: Bryan Richter Date: Tue, 10 Jun 2025 20:57:15 +0300 Subject: [PATCH] Touch up docs and remove unclear comments --- CURATORS.md | 12 ++++++------ automated/build.sh | 3 --- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/CURATORS.md b/CURATORS.md index ce245869..3a66ee70 100644 --- a/CURATORS.md +++ b/CURATORS.md @@ -19,8 +19,8 @@ process works: * [build-constraints.yaml](https://github.com/commercialhaskell/stackage/blob/master/build-constraints.yaml) specifies packages to be included in Stackage * [curator](https://github.com/commercialhaskell/curator) combines build-constraints.yaml with the current state of Hackage to create a build plan for a Stackage Nightly * `curator` can check that build plan to ensure all version bounds are consistent - * The [Travis job](https://github.com/commercialhaskell/stackage/blob/master/.travis.yml) performs these two steps to provide immediate feedback on pull requests -* Docker builds [builds](https://github.com/commercialhaskell/stackage/actions/workflows/image.yml) + * On pull requests, the GitHub action [performs these two steps](https://github.com/commercialhaskell/stackage/blob/master/etc/check.sh) to provide immediate feedback on pull requests +* Docker [builds](https://github.com/commercialhaskell/stackage/actions/workflows/image.yml) * The stackage-build server (described below) is able to run automated builds using the [build.sh script](https://github.com/commercialhaskell/stackage/blob/master/automated/build.sh) * When a new (nightly or LTS) build is completed, it is uploaded to [stackage-snapshots](https://github.com/commercialhaskell/stackage-snapshots) * Once a week, we run an LTS minor bump. Instead of using build-constraints.yaml, that job takes the previous LTS release, turns it into `^>=` constraints, and then bumps the version numbers to the latest on Hackage, in accordance with the generated constraint. @@ -28,7 +28,7 @@ process works: ## Pull requests -The typical story on pull requests is: If Travis accepts it and the +The typical story on pull requests is: If the checks pass and the author only added packages under his/her own name, merge it. If the build later fails (see [Adding Debian packages]), then block the package until it's fixed. @@ -46,9 +46,9 @@ Builds may fail because of unrelated bounds changes. If this happens, first add any version bounds to get master into a passing state (see "Fixing bounds issues"), then re-run the travis build. -A common issue is that authors submit newly uploaded packages, it can -take up to an hour before this has synced across the stack -infrastructure. You can usually compare the versions of the package in +A common issue is that authors submit newly uploaded packages. It can +take up to an hour before the package has synced from Hackage across the +Stackage infrastructure. You can usually compare the versions of the package in https://github.com/commercialhaskell/all-cabal-metadata/tree/master/packages/ to what's on hackage to see if this is the case. Wait an hour and re-run the pull request. diff --git a/automated/build.sh b/automated/build.sh index c559a2ed..034b7711 100755 --- a/automated/build.sh +++ b/automated/build.sh @@ -111,8 +111,6 @@ docker run --rm -v $(pwd)/curator:/curator -v $(pwd)/stack:/stack $IMAGE /bin/ba ARGS_COMMON="--rm -v $WORKDIR:$C_HOME/work -w $C_HOME/work -v $BINDIR/curator:/usr/bin/curator:ro -v /etc/passwd:/etc/passwd:ro -v /etc/group:/etc/group:ro -v $BINDIR/stack:/usr/bin/stack:ro -v $STACK_DIR:$C_HOME/.stack -v $PANTRY_DIR:$C_HOME/.stack/pantry -v $HOME/.aws/config:$C_HOME/.aws/config:ro" ARGS_PREBUILD="$ARGS_COMMON -u $USERID -e HOME=$C_HOME -v $DOT_STACKAGE_DIR:$C_HOME/.stackage" ARGS_BUILD="$ARGS_COMMON" -# instance-data is an undocumented feature of S3 used by amazonka, -# see https://github.com/brendanhay/amazonka/issues/271 ARGS_UPLOAD="$ARGS_PREBUILD -v $HACKAGE_CREDS:/hackage-creds:ro -v $SSH_DIR:$C_HOME/.ssh:ro -v $GITCONFIG:$C_HOME/.gitconfig:ro -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY ${AWS_ENDPOINT_URL:+-e AWS_ENDPOINT_URL=$AWS_ENDPOINT_URL} -v $DOT_STACKAGE_DIR:/dot-stackage" # for debugging etc @@ -193,7 +191,6 @@ docker run $ARGS_UPLOAD -e "CURATOR_AWS_OPTIONS=--only-show-errors" $IMAGE /bin/ " date -# was fixed in https://github.com/commercialhaskell/curator/pull/24 docker run $ARGS_UPLOAD $IMAGE curator hackage-distro --target $TARGET # Build and push docker image fpco/stack-build & fpco/stack-build-small for current release