gof3

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2023 License: MIT Imports: 1 Imported by: 0

README

gof3

Go implementation for the Friendly Forge Format

Building

  • Install go >= v1.20
  • make f3
  • ./f3 mirror -h # not yet functional

Testing

Requirements

The tests require a live GitLab instance as well as a live Forgejo instance and will use up to 16GB of RAM.

Preparing the environment

  • Install docker
  • serials=1 tests/setup-forgejo.sh

Running

  • go test lab.forgefriends.org/friendlyforgeformat/gof3/...

License

This project is licensed under the MIT License.

Hacking

The JSON schemas come from the f3-schemas repository and should be updated as follows:

cd format ; rm -fr schemas ; git --work-tree schemas clone https://lab.forgefriends.org/friendlyforgeformat/f3-schemas ; rm -fr f3-schemas

They cannot be a submodule.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ForgeInterface

type ForgeInterface interface {
	SetContext(context.Context)
}

Directories

Path Synopsis
f3
tests
SPDX-License-Identifier: MIT
SPDX-License-Identifier: MIT
uri

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL