* Add bootstrap postjob to CI config

Add a new job to the bootstrap.yml GitHub action config.
This job succeeds if, and only if, all the other bootstrap
jobs succeed.

* Do not run bootstrap CI jobs for documentation changes

The approach was already introduced in #9355 for the validate jobs.
This commit introduces the same change also for the bootstrap jobs.

* Also ignore CONTRIBUTING.md and README.md in CI

We do not run the entire CI suite for documentation changes.
Previously, only changes which were restricted to the 'docs/'
subdirectory were considered to be documentation changes.
With this commit we also recognize changes to README.md and
CONTRIBUTING.md as documentation changes.

* Document improved CI for documentation in CONTRIBUTING.md

The CONTRIBUTING.md file now mentions that documentation changes
do not waste expensive CI resources.

* Recognize all README.md in subdirs as documentation

Expensive CI jobs should not run on changes which affect only
README.md files.

There were two failing tests:

1. CCompilerOverride, was attempting to use gcc.exe rather than
   clang.exe without also overriding the C options which led to
   incorrect options being passed to gcc.exe. The fix is to override to
   clang.exe on ghc-9.4 or newer.
2. ForeignLibs exposes a bug in GHC
   (ghc/ghc#24185) and hence is
   skipped for GHCs newer than 9.4 where it was first introduced.

Towards fixing #8451, we just need to fix the shared library issue now.

Adding test becomes a checkmark instead of “bonus points”.

The github workflows are not run if the
changes are completely contained within
the doc/ subdirectory. The only exception
is the users-guide.yml github action.

Bump haskell-actions/run-fourmolu to v9 and fix fourmolu version to 0.12.0.0. This makes explicit which version is used and avoids unexpected changes later on.

The current version v8 of run-fourmolu uses fourmolu-0.12.0.0 so this should not produce any change in formatting now.

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Andrea Bedini <andrea@andreabedini.com>

If a pull request gets the "merge+no rebase" label, it' will be merged directly to master without a rebase/squash or queue. This can be useful in cases when contributors don't allow updating their branches.

* Fix PROCS for Darwin

* Add fixity information

* Fix file exclusions

* Fix formatting

* Fix CI linting

* Simplify 'make style' without 'find'

* Add in backwards-compatible fourmolu 0.13 config

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

f-a authored 1 year ago and Artem Pelenitsyn committed 1 year ago

Labels are not supported in PR templates, see
https://github.com/orgs/community/discussions/12815

* Unwrap text in templates

GitHub markdown does not do auto-unwrapping.

* Switch to one-template PR

This Stack Overflow answer [1] details how to have multiple PR templates
on GitHub. The UX is not that immediate (user has to click on preview, and
then another link).
A single page with two templates (where you fill in the one you
pick and erase the other) is more friendly.

[1] https://stackoverflow.com/a/75030350

* Whitespace

* Made PR instruction impersonal

For consistency with other bullet points.

* Revamp issue templates

* Add “Feature request” template

* Integrate Artem’s review

- `cabal` → Cabal
- add “type: enhancement” label

* Add “Documentation” issue template

* Add labels to “Bug report” template.

“type: bug” and ”needs-triage”. Suggested by Artem.

* Add “Question” issue template

* Fix typos

Spotted by Brandon.

* Fix English in “Question” template

Fix by Brandon.

Add “needs-review” to Pull Request template

As suggested by Artem.

* Split PR template in two

Split in full (PR modifies `cabal` behaviour) and simple (otherwise).

* Add Github PR Convention to PR templates

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Remove v2-prefix from other documentation where appropriate

* Added a changelog file

* Merge branch 'master' of github.com:haskell/cabal into remove-v2-from-docs

* Implemented PR feedback

* Reverted changes to regression tests

* Update CONTRIBUTING.md

Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>

* Update bootstrap/bootstrap.py

Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>

* Apply suggestions from code review

Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>

* Merge branch 'master' into remove-v2-from-docs

* Removed changelog entry

* Merge branch 'remove-v2-from-docs' of github.com:aspidites/cabal into remove-v2-from-docs

* Reverted bootstrap/README.md

* Merge branch 'master' into remove-v2-from-docs

Co-authored-by: ulysses4ever <6832600+ulysses4ever@users.noreply.github.com>

Phil de Joux authored 1 year ago and Artem Pelenitsyn committed 1 year ago

* hlint --default -j . > .hlint.yaml

* Ignore modules that #include "MachDeps.h"

  Warning: Can't find file "MachDeps.h" in directories
	./cabal-testsuite/PackageTests/CmmSources/src
	.
  Asked for by: ./cabal-testsuite/PackageTests/CmmSources/src/Demo.hs  at line 8 col 1

  Warning: Can't find file "MachDeps.h" in directories
	./cabal-testsuite/PackageTests/CmmSourcesDyn/src
	.
  Asked for by: ./cabal-testsuite/PackageTests/CmmSourcesDyn/src/Demo.hs  at line 8 col 1

* Ignore the manually generated Lexer.hs

	templates/Lexer.x:10:1-20: Warning: Use fewer LANGUAGE pragmas
	Found:
	  {-# LANGUAGE CPP #-}
	  {-# LANGUAGE CPP #-}

	Perhaps:
	  {-# LANGUAGE CPP #-}

	1 hint

* Ignore templates/Paths_pkg.template.hs for its parse error

* Ignore templates/SPDX*.hs for their parse errors

* Add a linting workflow and rename the formatting one

* Redo default configuration with hlint-3.5

	I had mistakenly used a development build before:

	$ hlint --version
	HLint v3.6.20230213, (C) Neil Mitchell 2006-2022

* Shorten github workflow

Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 2 to 3.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/v2...v3

)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* CI: add automated GitHub prereleases

* CI: gzip binary artifacts (ffaf1's review)

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Regenerate Lexer.hs with Alex 3.2.7.2 to fix issue ##8892 (out-of-bound
access due to https://github.com/haskell/alex/pull/223).

This reverts commit e159a12c.

* Add instructions to the PR tempalte for manual QA

* Add explanations in the contributing guide

* Grammar review

* Reword

* Line breaks

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

It hasn't been used for a while now.

haskell/acitons support prereleases since recently, and so, a separate
workflow is not necessary.

undo 6bd17fc from #8844; the change was made in response to an issue
that was later fixed on the haskell/action side

See comments.

* Bump versions on master branch to 3.11

* Try to fix CI by setting cabal-testsuite stable Cabal version to 3.8 back again

* Update bootstrap configuration

* Work around bounds problem with cabal-install-parsers

* Update bootstrap files

* Try to update the Custom setup cabal to 3.10 according to Artem's suggestion

* CI: cabal-3.10 compat: actions/cache has to go before cabal update

* Fix failing old GHC CI builds by adding XDG's ~/.local/bin to GITHUB_PATH

---------

Co-authored-by: Artem Pelenitsyn <a.pelenitsyn@gmail.com>

Had to block lib/cli-suite tests on Windows, see discussion starting here:

- https://github.com/haskell/cabal/pull/8754#issuecomment-1435025848