Working on code

Releases and Pages

Mark a version with a release and notes, download code as ZIP or tar.gz, and publish a static site from a branch with Pages.

Releases

A release marks a tag with a title and notes, so people can see what's in each version and download it.

1. On the Code tab, open Releases and choose New release.
2. Pick an existing tag, or type a new tag name and the branch to make it from.
3. Give it a title. The notes are drafted for you from the changes merged since the previous release (or Everything so far for the first one); edit them as you like.
4. Save draft to finish later, or Publish release.

Drafts are hidden from people who can only read the repository. Everyone who can see the repository sees published releases, with their notes and downloads.

Tags can also be pushed with Git as usual. Making and deleting tags needs the maintain role.

Downloads

Download ZIP on the Code tab gets the files at the branch or tag you're looking at, without the history. A .tar.gz is offered too, and each release has both.

Pages

Pages publishes a static website from a repository: docs, a portfolio, a class site, or anything that's plain HTML, CSS and JavaScript.

1. In the repository's Settings → Pages, choose the branch, and the folder the site is in: the root, or docs/.
2. Turn it on. The site is published at https://<owner>.<pages domain>/<repo>/, and updated with every push to that branch.

Pages needs your admin to have set it up with a domain of its own (PAGES_URL); until then the panel says it's off. Sites never share an address with Fettlecode itself, so a site's scripts can't reach your account. See Settings.

Pages serves files as they are: build your site first (for example with a static site generator), and commit the output to the branch and folder you chose.