Publishing your flakes to FlakeHub

You can publish your flakes to FlakeHub using the flakehub-push (opens in a new tab) GitHub Action.

We recommend using FlakeHub's flake publishing wizard (opens in a new tab) as a quickstart.

Suggestions for your flake's README

While it's totally up to you what you put in your README, we recommend something along these lines:

# Use as a flake
 
[![FlakeHub](https://img.shields.io/endpoint?url=https://flakehub.com/f/YourOrgName/YourFlakeName/badge)](https://flakehub.com/flake/YourOrgName/YourFlakeName)
 
Add `YourFlakeName` to your `flake.nix`:
 
```nix
{
  inputs.YourFlakeName.url = "https://flakehub.com/f/YourOrgName/YourFlakeName/*.tar.gz";
 
  outputs = { self, YourFlakeName }: {
    # Use in your outputs
  };
}
```

Notice the badge from shields.io (opens in a new tab) and the example flake.nix file.

Flake metadata

Property	Source
Description	The description field of the `flake.nix`.
License	Read from the GitHub API. Overridden by the `spdx-expression` option.
Name	Read from the ambient environment. Overridden via the name option.
README	Read from `README.md` in the root of the flake.
Tag	Read from the ambient environment. Overridden via the tag option.
Rolling	Release version numbers. Rolling releases are `0.[rolling-minor].[commit-count]`, where the commit count comes from the GitHub API.
Labels	Read from the repo's GitHub topics. Additional labels can be set with the extra-labels option.

Configuration

Parameter	Description	Required?	Default
`directory`	the directory of your flake (useful for subflakes)
`extra-labels`	`flakehub-push` automatically uses the GitHub repo's topics as labels. This `extra-labels` parameter enables you to add extra labels beyond that as a comma-separated string. Only alphanumeric characters and hyphens are allowed in labels and the maximum length of labels is 50 characters. You can specify a maximum of 20 extra labels, and have a maximum of 25 labels, including those that we retrieve from GitHub. Any labels after the 25th will be ignored.
`flakehub-push-binary`	Run a version of the `flakehub-push` binary from somewhere already on disk. Conflicts with all other `flakehub-push-*` options.
`flakehub-push-branch`	The branch of `flakehub-push` to use. Conflicts with all other `flakehub-push-*` options.		`main`
`flakehub-push-pr`	The PR of `flakehub-push` to use. Conflicts with all other `flakehub-push-*` options.
`flakehub-push-revision`	The revision of `flakehub-push` to use. Conflicts with all other `flakehub-push-*` options.
`flakehub-push-tag`	The tag of `flakehub-push` to use. Conflicts with all other `flakehub-push-*` options.
`flakehub-push-url`	A URL pointing to a `flakehub-push` binary. Overrides all other `flakehub-push-*` options.
`git-root`	the git root of your flake		`.`
`github-token`	A GitHub token for making authenticated GitHub API requests		`${{ github.token }}`
`host`	The FlakeHub server to use		`https://api.flakehub.com`
`log-directives`	A list of Tracing directives, comma separated, `-`s replaced with `_` (such as `nix_installer=trace`, see https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives)		`flakehub_push=info`
`logger`	The logger to use for install (options are `pretty`, `json`, `full`, `compact`)		`full`
`mirror`	If the repository is mirrored via DeterminateSystems' mirror functionality. This is only usable by DeterminateSystems.
`repository`	The actual GitHub repository containing your flake. In the format of OrgName/RepoName.	✅	`${{ github.repository }}`
`rolling`	For untagged releases, use a rolling versioning scheme. When this is enabled, the default versioning scheme is 0.1.[commit count]+rev-[git sha]. To customize the SemVer minor version, set the `rolling-minor` option.
`rolling-minor`	Specify the SemVer minor version of your rolling releases. All releases will follow the versioning scheme '0.[rolling-minor].[commit count]+rev-[git sha]'
`spdx-expression`	A valid SPDX license expression. This will be used in place of what GitHub claims your repository's `spdxIdentifier` is.
`tag`	example: v0.1.1
`name`	The name of your published flake. In the format of OrgName/RepoName. OrgName must match your organization's GitHub root name or the publish will fail.
`visibility`	`public` or `unlisted`	✅

Learn Nix FlakeHub CLI