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

feat: lake: Reservoir-related configuration for packages #4770

Merged
merged 12 commits into from
Sep 2, 2024

Conversation

tydeu
Copy link
Member

@tydeu tydeu commented Jul 17, 2024

Adds additional fields to the package configuration which will be used by Reservoir:

  • version: The version of the package. Follows Lean's model of <major>.<minor>.<patch>[-<specialDescr>].
  • versionTags: A pattern matching the set of Git tags Reservoir should consider package version revisions.
  • description: A short description for the package. Takes precedence over the GitHub's description.
  • keywords: An array of package keywords that will be used to group packages into categories on Reservoir. Takes precedence over labels on the repository.
  • homepage: A URL to a website for the package. Takes precedence over GitHub's homepage.
  • license: An SPFX license identifier for the package's license (not verified to be well-formed).
  • licenseFiles: An array of (relative) files the contain license information (e.g., #["LICENSE", "NOTICE"] for Apache 2.0).
  • readmeFile: Relative path to the package's readme (enables non-standard README locations).
  • reservoir: Reservoir will use this setting to determine whether to include packages in its index.

Also adds two new CLI commands:

  • lake reservoir-config: Used by Reservoir to extract a package's configuration.
  • lake check-build: Determines whether the package has any default build targets configured.

The Reservoir configuration also makes uses of the exiting name and platformIndependent fields.

@github-actions github-actions bot added the toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN label Jul 17, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Jul 17, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Jul 17, 2024
@leanprover-community-mathlib4-bot leanprover-community-mathlib4-bot added the builds-mathlib CI has verified that Mathlib builds against this PR label Jul 17, 2024
@leanprover-community-mathlib4-bot
Copy link
Collaborator

leanprover-community-mathlib4-bot commented Jul 17, 2024

Mathlib CI status (docs):

leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Jul 17, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Jul 17, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Jul 17, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Jul 17, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Jul 19, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Jul 19, 2024
@tydeu tydeu changed the title feat: lake: package versions & keywords feat: lake: Reservoir-related configuration for packages Jul 19, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Jul 19, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Jul 19, 2024
@leodemoura leodemoura force-pushed the master branch 2 times, most recently from 32d60c5 to 696f70b Compare July 20, 2024 02:58
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Aug 30, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Aug 30, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Aug 30, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Aug 30, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Aug 31, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Aug 31, 2024
@tydeu tydeu marked this pull request as ready for review August 31, 2024 20:38
@tydeu tydeu added the release-ci Enable all CI checks for a PR, like is done for releases label Aug 31, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Sep 2, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Sep 2, 2024
@tydeu tydeu added this pull request to the merge queue Sep 2, 2024
Merged via the queue into leanprover:master with commit df9cdcd Sep 2, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builds-mathlib CI has verified that Mathlib builds against this PR release-ci Enable all CI checks for a PR, like is done for releases toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants