gllib

package module
v0.2.2 Latest Latest
Warning

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

 Go to latest Published: Jan 6, 2026 License: GPL-3.0 Imports: 10 Imported by: 1

README

GLLib

Getting started

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!

Add your files

cd existing_repo
git remote add origin https://gitlab.tartarefr.eu/sources/gllib.git
git branch -M main
git push -uf origin main

Integrate with your tools

Collaborate with your team

Test and Deploy

Use the built-in continuous integration in GitLab.

Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to makeareadme.com for this template.

Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

Name

Choose a self-explaining name for your project.

Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

For open source projects, say how it is licensed.

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetGitUrl 

func GetGitUrl(remoteName string, verbose bool) string

func ReadFromFile 

func ReadFromFile(filename string, kind string, verbose bool) string

func WriteFile 

func WriteFile(filename string, json []byte, verbose bool)

Types

type GLApi 

type GLApi struct {
	UrlBase string
	Token   string
	Verbose bool
}

func NewGLApi 

func NewGLApi(urlBase string, token string, verbose bool) GLApi

func (*GLApi) CallGitlabApi 

func (glapi *GLApi) CallGitlabApi(uri string, method string, data []byte) ([]byte, int, error)

type GitlabEnv 

type GitlabEnv struct {
	UrlBase    string
	Token      string
	Verbose    bool
	DryrunMode bool
	ProjectId  string
	Glapi      GLApi
	GitlabData []GitlabEnvData
	FileData   []GitlabEnvData
}

func NewGitlabEnv 

func NewGitlabEnv(UrlBase string, Token string, Verbose bool) GitlabEnv

func (*GitlabEnv) CompareEnv 

func (glenv *GitlabEnv) CompareEnv() ([]GitlabEnvData, []GitlabEnvData, []GitlabEnvData)

func (*GitlabEnv) DeleteEnv 

func (glenv *GitlabEnv) DeleteEnv(env GitlabEnvData) error

func (*GitlabEnv) ExportEnvs 

func (glenv *GitlabEnv) ExportEnvs(filename string)

func (*GitlabEnv) GetEnvsFromGitlab 

func (glenv *GitlabEnv) GetEnvsFromGitlab() error

func (*GitlabEnv) GetMissingEnvs 

func (glenv *GitlabEnv) GetMissingEnvs(envsFromVars []string) []string

func (*GitlabEnv) ImportEnvs 

func (glenv *GitlabEnv) ImportEnvs(filename string)

func (*GitlabEnv) InsertEnv 

func (glenv *GitlabEnv) InsertEnv(env GitlabEnvData) error

func (*GitlabEnv) UpdateEnv 

func (glenv *GitlabEnv) UpdateEnv(env GitlabEnvData) error

type GitlabEnvData 

type GitlabEnvData struct {
	Id          int    `json:"id"`
	Name        string `json:"name"`
	State       any    `json:"state"`
	Url         any    `json:"external_url"`
	Description any    `json:"description"`
}

type GitlabNamespaceData 

type GitlabNamespaceData struct {
	Id       int    `json:"id"`
	Name     string `json:"name"`
	Path     string `json:"path"`
	FullPath string `json:"full_path"`
	ParentId int    `json:"parent_id"`
	WebUrl   string `json:"web_url"`
}

type GitlabProject 

type GitlabProject struct {
	UrlBase        string
	Token          string
	Verbose        bool
	MembershipOnly bool
	SimpleRequest  bool
	DryrunMode     bool
	Glapi          GLApi
	Data           []GitlabProjectData
}

func NewGitlabProject 

func NewGitlabProject(UrlBase string, Token string, Verbose bool) GitlabProject

func (*GitlabProject) ExportProjects 

func (glproj *GitlabProject) ExportProjects(filename string)

func (*GitlabProject) GetGroupIdByProjectId 

func (glproj *GitlabProject) GetGroupIdByProjectId(id int) int

func (*GitlabProject) GetProjectIdByRepoUrl 

func (glproj *GitlabProject) GetProjectIdByRepoUrl(url string) int

func (*GitlabProject) GetProjectsFromGitlab 

func (glproj *GitlabProject) GetProjectsFromGitlab() error

func (*GitlabProject) ImportProjects 

func (glproj *GitlabProject) ImportProjects(filename string)

type GitlabProjectData 

type GitlabProjectData struct {
	Id                int                 `json:"id"`
	Name              string              `json:"name"`
	Description       any                 `json:"description"`
	Path              string              `json:"path"`
	NameWithNamespace string              `json:"name_with_namespace"`
	PathWithNamespace string              `json:"path_with_namespace"`
	SshUrlToRepo      string              `json:"ssh_url_to_repo"`
	HttpUrlToRepo     string              `json:"http_url_to_repo"`
	WebUrl            string              `json:"web_url"`
	Visibility        string              `json:"visibility"`
	Namespace         GitlabNamespaceData `json:"namespace"`
	IsArchived        bool                `json:"archived"`
	LastActivity      string              `json:"last_activity_at"`
}

type GitlabVar 

type GitlabVar struct {
	UrlBase          string
	Token            string
	Verbose          bool
	DryrunMode       bool
	ProjectId        string
	GroupId          string
	Glapi            GLApi
	GitlabData       []GitlabVarData
	FileData         []GitlabVarData
	GitlabGroupData  []GitlabVarData
	FileGroupData    []GitlabVarData
	GitlabGlobalData []GitlabVarData
	FileGlobalData   []GitlabVarData
}

func NewGitlabVar 

func NewGitlabVar(UrlBase string, Token string, Verbose bool) GitlabVar

func (*GitlabVar) CompareGlobalVar 

func (glvar *GitlabVar) CompareGlobalVar() ([]GitlabVarData, []GitlabVarData, []GitlabVarData)

func (*GitlabVar) CompareGroupVar 

func (glvar *GitlabVar) CompareGroupVar() ([]GitlabVarData, []GitlabVarData, []GitlabVarData)

func (*GitlabVar) CompareVar 

func (glvar *GitlabVar) CompareVar() ([]GitlabVarData, []GitlabVarData, []GitlabVarData)

func (*GitlabVar) DeleteGlobalVar 

func (glvar *GitlabVar) DeleteGlobalVar(variable GitlabVarData) error

func (*GitlabVar) DeleteGroupVar 

func (glvar *GitlabVar) DeleteGroupVar(variable GitlabVarData) error

func (*GitlabVar) DeleteVar 

func (glvar *GitlabVar) DeleteVar(variable GitlabVarData) error

func (*GitlabVar) ExportGlobalVars 

func (glvar *GitlabVar) ExportGlobalVars(filename string)

func (*GitlabVar) ExportGroupVars 

func (glvar *GitlabVar) ExportGroupVars(filename string)

func (*GitlabVar) ExportVars 

func (glvar *GitlabVar) ExportVars(filename string)

func (*GitlabVar) GetEnvsFromGlobalVars 

func (glvar *GitlabVar) GetEnvsFromGlobalVars() []string

func (*GitlabVar) GetEnvsFromGroupVars 

func (glvar *GitlabVar) GetEnvsFromGroupVars() []string

func (*GitlabVar) GetEnvsFromVars 

func (glvar *GitlabVar) GetEnvsFromVars() []string

func (*GitlabVar) GetGlobalVarsFromGitlab 

func (glvar *GitlabVar) GetGlobalVarsFromGitlab() error

func (*GitlabVar) GetGroupVarsFromGitlab 

func (glvar *GitlabVar) GetGroupVarsFromGitlab() error

func (*GitlabVar) GetVarsFromGitlab 

func (glvar *GitlabVar) GetVarsFromGitlab() error

func (*GitlabVar) ImportGlobalVars 

func (glvar *GitlabVar) ImportGlobalVars(filename string)

func (*GitlabVar) ImportGroupVars 

func (glvar *GitlabVar) ImportGroupVars(filename string)

func (*GitlabVar) ImportVars 

func (glvar *GitlabVar) ImportVars(filename string)

func (*GitlabVar) InsertGlobalVar 

func (glvar *GitlabVar) InsertGlobalVar(variable GitlabVarData) error

func (*GitlabVar) InsertGroupVar 

func (glvar *GitlabVar) InsertGroupVar(variable GitlabVarData) error

func (*GitlabVar) InsertVar 

func (glvar *GitlabVar) InsertVar(variable GitlabVarData) error

func (*GitlabVar) UpdateGlobalVar 

func (glvar *GitlabVar) UpdateGlobalVar(variable GitlabVarData) error

func (*GitlabVar) UpdateGroupVar 

func (glvar *GitlabVar) UpdateGroupVar(variable GitlabVarData) error

func (*GitlabVar) UpdateVar 

func (glvar *GitlabVar) UpdateVar(variable GitlabVarData) error

type GitlabVarData 

type GitlabVarData struct {
	Key         string `json:"key"`
	Value       string `json:"value"`
	Description any    `json:"description"`
	Env         string `json:"environment_scope"`
	IsRaw       bool   `json:"raw"`
	IsHidden    bool   `json:"hidden"`
	IsProtected bool   `json:"protected"`
	IsMasked    bool   `json:"masked"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.