Skip to content

Commit

Permalink
Update all links to point to codeberg instead of github.
Browse files Browse the repository at this point in the history
  • Loading branch information
technomancy committed Jul 7, 2022
1 parent da6a8e0 commit 3379520
Show file tree
Hide file tree
Showing 26 changed files with 117 additions and 222 deletions.
41 changes: 23 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
# Contributing

Leiningen is the most widely-contributed-to Clojure project. We
welcome potential contributors and do our best to try to make it easy
to help out.
Leiningen is the most widely-contributed-to Clojure project a the time
of this writing. We welcome potential contributors and do our best to
try to make it easy to help out.

Discussion occurs primarily in the #leiningen channel on Libera chat.
Discussion occurs primarily in the #leiningen channel on [Libera
chat](https://libera.chat).

Please report issues on the
[GitHub issue tracker](https://github.com/technomancy/leiningen/issues).
[issue tracker](https://codeberg.org/leiningen/leiningen/issues).

Code submissions should
be sent as GitHub pull requests. Please use topic branches when
sending pull requests rather than committing directly to master in
order to minimize unnecessary merge commit clutter. Direct pull
requests towards the master branch, not the stable branch.
Code submissions should be sent as [pull
requests](https://codeberg.org/leiningen/leiningen/pulls). Please
use topic branches when sending pull requests rather than committing
directly to `main` in order to minimize unnecessary merge commit
clutter. Direct pull requests towards the `main` branch, not the
stable branch.

Leiningen is [mirrored at GitLab](https://gitlab.com/technomancy/leiningen)
and [tested on CircleCI](https://circleci.com/gh/technomancy/leiningen).
Note: the canonical repository for Leiningen is [on
Codeberg](https://codeberg.org/leiningen/leiningen) but we maintain [a
mirror on GitHub](https://github.com/technomancy/leiningen) for the
time being in order to ease the transition. Please update your links
and git remotes.

## Codebase

Expand All @@ -26,7 +31,7 @@ top-level project. The underlying mechanisms for things like
are implemented inside the `leiningen-core` subproject.

See the
[readme for the leiningen-core library](https://github.com/technomancy/leiningen/blob/master/leiningen-core/README.md)
[readme for the leiningen-core library](https://codeberg.org/leiningen/leiningen/blob/main/leiningen-core/README.md)
and `doc/PLUGINS.md` for more details on how Leiningen's codebase is
structured.

Expand Down Expand Up @@ -63,33 +68,33 @@ in the project root, though in most cases this will be done automatically. If
dependencies in leiningen-core change, you have to redo the `lein bootstrap`
step mentioned earlier.

Using `bin/lein` alone from the master branch without a full checkout
Using `bin/lein` alone from the main branch without a full checkout
is not supported. If you want to just grab a shell script to work
with, use the `stable` branch.

### Uberjar from Master

Since a development version is not uberjared, it can be rather slow compared to
a stable release. If this is annoying and you depend on a recent fix or
enhancement, you can build an uberjar from master as follows:
enhancement, you can build an uberjar from main as follows:

```bash
# NB! You have to use *bin*/lein to build the uberjar
$ bin/lein uberjar
# ^ Last line printed from this command will tell the location of the standalone
$ cp target/leiningen-2.5.2-SNAPSHOT-standalone.jar $HOME/.lein/self-installs
$ cp bin/lein $HOME/bin/lein-master
$ cp bin/lein $HOME/bin/lein-main
```

Here, 2.5.2-SNAPSHOT is the version we've built, and we have `$HOME/bin` on our
$PATH.

Note that changes on master won't be visible in the uberjared version unless you
Note that changes on main won't be visible in the uberjared version unless you
overwrite both the lein script and a freshly created uberjar.

## Tests

Before you're asking for a pull request, we would be very happy if you ensure
Before you submit a pull request, we would be very happy if you ensure
that the changes you've done doesn't break any of the existing test cases. While
there is a test suite, it's not terribly thorough, so don't put too much trust
in it. Patches which add test coverage for the functionality they change are
Expand Down
48 changes: 27 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Leiningen

[![CircleCI](https://circleci.com/gh/technomancy/leiningen.svg?style=svg)](https://circleci.com/gh/technomancy/leiningen)
[![status-badge](https://ci.codeberg.org/api/badges/technomancy/leiningen/status.svg)](https://ci.codeberg.org/technomancy/leiningen)

<img src="https://leiningen.org/img/leiningen.jpg"
alt="Leiningen logo" title="The man himself" align="right" />
Expand All @@ -16,7 +16,7 @@ Leiningen is for automating Clojure projects without setting your hair on fire.
## Installation

If your preferred
[package manager](https://github.com/technomancy/leiningen/wiki/Packaging)
[package manager](https://codeberg.org/leiningen/leiningen/wiki/Packaging)
offers a recent version of Leiningen, try that first as long as it has version 2.x.

Leiningen installs itself on the first run of the `lein` shell script; there is no
Expand All @@ -34,10 +34,16 @@ Windows users can use the above script in the Linux subsystem or try
[Powershell version](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein.ps1)
instead.

Note: the canonical repository for Leiningen is [on
Codeberg](https://codeberg.org/leiningen/leiningen) but we maintain [a
mirror on GitHub](https://github.com/technomancy/leiningen) for the
time being in order to ease the transition. Please update your links
and git remotes.

## Basic Usage

The
[tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md)
[tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md)
has a detailed walk-through of the steps involved in creating a new
project, but here are the commonly-used tasks:

Expand Down Expand Up @@ -73,58 +79,58 @@ The `project.clj` file in the project root should look like this:
(defproject myproject "0.5.0-SNAPSHOT"
:description "A project for doing things."
:license "Eclipse Public License 1.0"
:url "http://github.com/technomancy/myproject"
:url "http://codelab.org/technomancy/myproject"
:dependencies [[org.clojure/clojure "1.8.0"]]
:plugins [[lein-tar "3.2.0"]])
```

The `lein new` task generates a project skeleton with an appropriate
starting point from which you can work. See the
[sample.project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj)
[sample.project.clj](https://codeberg.org/leiningen/leiningen/blob/stable/sample.project.clj)
file (also available via `lein help sample`) for a detailed listing of
configuration options.

The `project.clj` file can be customized further with the use of
[profiles](https://github.com/technomancy/leiningen/blob/stable/doc/PROFILES.md).
[profiles](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PROFILES.md).

## Documentation

Leiningen documentation is organized as a number of guides:

### Usage

* [Tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md) (start here if you are new)
* [FAQ](https://github.com/technomancy/leiningen/blob/stable/doc/FAQ.md)
* [Profiles](https://github.com/technomancy/leiningen/blob/stable/doc/PROFILES.md)
* [Deployment & Distribution of Libraries](https://github.com/technomancy/leiningen/blob/stable/doc/DEPLOY.md)
* [Sample project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj)
* [Polyglot (e.g. Clojure/Java) projects](https://github.com/technomancy/leiningen/blob/stable/doc/MIXED_PROJECTS.md)
* [Tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md) (start here if you are new)
* [FAQ](https://codeberg.org/leiningen/leiningen/blob/stable/doc/FAQ.md)
* [Profiles](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PROFILES.md)
* [Deployment & Distribution of Libraries](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md)
* [Sample project.clj](https://codeberg.org/leiningen/leiningen/blob/stable/sample.project.clj)
* [Polyglot (e.g. Clojure/Java) projects](https://codeberg.org/leiningen/leiningen/blob/stable/doc/MIXED_PROJECTS.md)

### Development

* [Writing Plugins](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md)
* [Writing Templates](https://github.com/technomancy/leiningen/blob/stable/doc/TEMPLATES.md)
* [Contributing](https://github.com/technomancy/leiningen/blob/stable/CONTRIBUTING.md)
* [Building Leiningen](https://github.com/technomancy/leiningen/blob/stable/CONTRIBUTING.md#bootstrapping)
* [Writing Plugins](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PLUGINS.md)
* [Writing Templates](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TEMPLATES.md)
* [Contributing](https://codeberg.org/leiningen/leiningen/blob/stable/CONTRIBUTING.md)
* [Building Leiningen](https://codeberg.org/leiningen/leiningen/blob/stable/CONTRIBUTING.md#bootstrapping)

## Plugins

Leiningen supports plugins which may introduce new tasks. See
[the plugins wiki page](https://github.com/technomancy/leiningen/wiki/Plugins)
[the plugins wiki page](https://codeberg.org/leiningen/leiningen/wiki/Plugins)
for a full list. If a plugin is needed for successful test or build
runs, (such as `lein-tar`) then it should be added to `:plugins` in
project.clj, but if it's for your own convenience (such as
`lein-pprint`) then it should be added to the `:plugins` list in the
`:user` profile in `~/.lein/profiles.clj`. See the
[profiles guide](https://github.com/technomancy/leiningen/blob/stable/doc/PROFILES.md)
[profiles guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PROFILES.md)
for details on how to add to your `:user` profile. The
[plugin guide](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md)
[plugin guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/PLUGINS.md)
explains how to write plugins.

## License

Source Copyright © 2009-2021 Phil Hagelberg, Alex Osborne, Dan Larkin, and
[contributors](https://github.com/technomancy/leiningen/contributors).
Source Copyright © 2009-2022 Phil Hagelberg, Alex Osborne, Dan Larkin, and
contributors.
Distributed under the Eclipse Public License, the same as Clojure
uses. See the file COPYING.

Expand Down
2 changes: 1 addition & 1 deletion bin/release
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ cd $LEIN_ROOT

git commit -a -m "Release $RELEASE_VERSION"
git tag -s $RELEASE_VERSION -m "Release $RELEASE_VERSION"
git push && git push --tags && git push origin master:stable
git push && git push --tags && git push origin main:stable

echo "Upload $SELF_INSTALL_JAR and $SELF_INSTALL_JAR.asc to GitHub:"
echo "https://github.com/technomancy/leiningen/releases/new?tag=$RELEASE_VERSION"
Expand Down
4 changes: 2 additions & 2 deletions doc/DEPLOY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

Getting your library into [Clojars](https://clojars.org) is fairly
straightforward as is documented near the end of
[the Leiningen tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md).
[the Leiningen tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md).
However, deploying elsewhere is not always that straightforward.

## Private Repositories
Expand Down Expand Up @@ -137,7 +137,7 @@ haven't set up credentials, but it's convenient to set it so you don't have to
re-enter it every time you want to deploy. You will need
[gpg](https://www.gnupg.org/) installed and a key pair configured. If
you need help with either of those, see the
[GPG guide](https://github.com/technomancy/leiningen/blob/stable/doc/GPG.md).
[GPG guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/GPG.md).

### GPG

Expand Down
10 changes: 5 additions & 5 deletions doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

**Q:** What's a group ID? How do snapshots work?
**A:** See the
[tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md)
[tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md)
for background.

**Q:** How should I pick my version numbers?
Expand All @@ -25,7 +25,7 @@

**Q:** What if my project depends on jars that aren't in any repository?
**A:** You will need to get them in a repository. The
[deploy guide](https://github.com/technomancy/leiningen/blob/stable/doc/DEPLOY.md)
[deploy guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md)
explains how to set up a private repository. In general it's easiest
to deploy them to a static HTTP server or a private S3 bucket. Once
the repo is set up, `lein deploy private-repo com.mycorp/somejar
Expand All @@ -38,7 +38,7 @@
**Q:** I want to hack a project and one of its dependencies, but it's annoying to switch between them.
**A:** Leiningen provides a feature called *checkout dependencies* to
make this smoother. See the
[tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md)
[tutorial](https://codeberg.org/leiningen/leiningen/blob/stable/doc/TUTORIAL.md)
to learn more.

**Q:** Is it possible to exclude indirect dependencies?
Expand Down Expand Up @@ -119,7 +119,7 @@

**Q:** Still too slow; what else can make startup faster?
**A:** The wiki has a page covering
[ways to improve startup time](https://github.com/technomancy/leiningen/wiki/Faster).
[ways to improve startup time](https://codeberg.org/leiningen/leiningen/wiki/Faster).

**Q:** What if I care more about long-term performance than startup time?
**A:** Leiningen 2.1.0 onward get a speed boost by disabling optimized
Expand Down Expand Up @@ -239,7 +239,7 @@ happens it is strongly recommended to add an `:exclusion` and report a
bug with the dependency which does this.

**Q:** `lein`/`lein.bat` won't download `leiningen-x.y.z-SNAPSHOT.jar`
**A:** You probably downloaded `lein`/`lein.bat` from the [master branch](https://github.com/technomancy/leiningen/tree/master/bin). Unless you plan to build leiningen yourself or help develop it, we suggest you use the latest stable version: [lein](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein)/[lein.bat](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein.bat)
**A:** You probably downloaded `lein`/`lein.bat` from the [main branch](https://codeberg.org/leiningen/leiningen/tree/main/bin). Unless you plan to build leiningen yourself or help develop it, we suggest you use the latest stable version: [lein](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein)/[lein.bat](https://raw.githubusercontent.com/technomancy/leiningen/stable/bin/lein.bat)

**Q:** I have a dependency whose group ID and/or artifact ID starts with a
number (which is invalid for symbols in Clojure). How can I add it to my
Expand Down
2 changes: 1 addition & 1 deletion doc/GPG.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Leiningen uses GPG for three things: decrypting credential files,
signing release artifacts, and signing tags. We'll focus on artifact
signing here; for information on credentials encryption/decryption,
see the
[deploy guide](https://github.com/technomancy/leiningen/blob/stable/doc/DEPLOY.md). Once
[deploy guide](https://codeberg.org/leiningen/leiningen/blob/stable/doc/DEPLOY.md). Once
you are configured to sign releases, signing tags should be
straightforward.

Expand Down
10 changes: 5 additions & 5 deletions doc/PLUGINS.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ on that argument.

However, if you need to call other Leiningen functions or have no need
to run anything inside the context of the project's own process,
making a plugin might be the right choice if one doesn't [exist already](https://github.com/technomancy/leiningen/wiki/plugins),
making a plugin might be the right choice if one doesn't [exist already](https://codeberg.org/leiningen/leiningen/wiki/plugins),

## Writing a Plugin

Expand All @@ -87,11 +87,11 @@ has `:eval-in-leiningen true`, which causes all tasks to operate
inside the leiningen process rather than starting a subprocess to
isolate the project's code. Plugins need not declare a dependency on
Clojure itself; in fact
[all of Leiningen's own dependencies](https://github.com/technomancy/leiningen/blob/stable/project.clj)
[all of Leiningen's own dependencies](https://codeberg.org/leiningen/leiningen/blob/stable/project.clj)
will be available.

See the `lein-pprint` directory
[in the Leiningen source](https://github.com/technomancy/leiningen/tree/stable/lein-pprint)
[in the Leiningen source](https://codeberg.org/leiningen/leiningen/tree/stable/lein-pprint)
for a sample of a very simple plugin.

When emitting output, please use `leiningen.core.main/info`,
Expand Down Expand Up @@ -542,7 +542,7 @@ the argument list so that the `-main` function running inside the
project code gets access to it.

The vast majority of these cases are already covered by
[existing plugins](https://github.com/technomancy/leiningen/wiki/plugins),
[existing plugins](https://codeberg.org/leiningen/leiningen/wiki/plugins),
but if you have a case that doesn't exist and for some reason can't
spin it off into its own separate plugin, you can enable this behavior
by placing the `foo.clj` file defining the new task in
Expand All @@ -569,7 +569,7 @@ proper plugin.
## Have Fun

Please add your plugin to [the list on the
wiki](https://github.com/technomancy/leiningen/wiki/plugins) once it's ready.
wiki](https://codeberg.org/leiningen/leiningen/wiki/plugins) once it's ready.

Hopefully the plugin mechanism is simple and flexible enough to let
you bend Leiningen to your will.
2 changes: 1 addition & 1 deletion doc/PROFILES.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ Here is an example of such a case:
## Debugging

To see how a given profile affects your project map, use the
[lein-pprint](https://github.com/technomancy/leiningen/tree/stable/lein-pprint)
[lein-pprint](https://codeberg.org/leiningen/leiningen/tree/stable/lein-pprint)
plugin:

$ lein with-profile 1.4 pprint
Expand Down
2 changes: 1 addition & 1 deletion doc/TEMPLATES.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ you wish to be part of your template. For everything you add, make sure the
`liquid_cool.clj` file receives corresponding entries in that `->files`
call. For examples to follow, have a look inside [the \*.clj files for the
built-in
templates](https://github.com/technomancy/leiningen/tree/stable/resources/leiningen/new).
templates](https://codeberg.org/leiningen/leiningen/tree/stable/resources/leiningen/new).

## Testing Your Template

Expand Down
Loading

0 comments on commit 3379520

Please sign in to comment.