Giter Club home page Giter Club logo

software-templates's Introduction

software-templates

This repository is a collection of software and documentation templates for the Backstage community. The templates are organized into two folders: scaffolder-templates for Backstage Software Templates and documentation-templates for general documentation templates. Contributions are welcome for new and existing templates!

scaffolder-templates

Backstage Software Templates are used to create new software components through Backstage. These templates are intended as a starting point to build on for different use cases. You may also use them as provided, but we recommend pointing your Backstage app to a forked copy because the templates aren't versioned at this time, and as such breaking changes can happen without warning.

documentation-templates

The documentation templates provide recommended structure and content for different types of documentation, for example system architecture documents or runbooks.

software-templates's People

Contributors

addersuk avatar benjdlambert avatar bodilb avatar chaseajen avatar dhfherna avatar freben avatar iameap avatar joeporpeglia avatar mtlewis avatar nishkarshraj avatar orkohunter avatar pjungermann avatar satrox28 avatar timbonicus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

software-templates's Issues

github.com/project-slug in catalog-info.yaml shown "undefined:undefined"

I tried to run scaffolder-templates/clean-architecture-app, but catalog-info.yaml showned "undefined:undefined". Wonder what am I missing?

The code in catalog-info.yaml has

  annotations:
    github.com/project-slug: ${{values.destination.owner + "/" + values.destination.repo}}

but I don't see values.destination defined any where. What did I missed?

Point to gitlab

Hello, I have copied the repository to an private gitlab, and I would like to point them with a wildcard way. How can I do it? Is it possible?

Thanks a lot,
Matteo.

Create custom filters to use inside templates

Hi!

As we can see bellow, we can use parseRepoUrl filter inside template.

destination: ${{ parameters.repoUrl | parseRepoUrl }}

I'd like to know how can I create a custom function to use.

For example, I'm using EntityPicker to list all systems, but the value returned is system:foo, but in my parameter i need only entity name.

      input:
        template: 'template-ms'
        args:
          - --namespace
          - ${{ parameters.namespace }}
          - --template
          - webapi
          - --app-name
          - ${{ parameters.app_name }}
          - --system
          - ${{ parameters.system | getEntityName}}
          - --team
          - ${{ parameters.team}}
          - --domain
          - ${{ parameters.domain | getEntityName }}

So, I would create that getEntityName , but I couldn't find any documentation.

Thank you!

publish:github actions in docs template is not creating "main" branch in github

I am using below code in my documentation template to publish repository in github and then configured it in backstage but below template is creating master branch in place of main branch in github, and due to this many other functionality in github is creating the problem .
And, github is also deprecated master branch name as of now
Changelog


  • This actions: publish:github is creating the master branch and required some changes
- id: publish
      name: Publish
      action: publish:github
      input:
        allowedHosts: ["github.com"]
        description: This is ${{ parameters.name }}
        repoUrl: ${{ parameters.repoUrl }}

    - id: register
      name: Register
      action: catalog:register
      input:
        repoContentsUrl: ${{ steps.publish.output.repoContentsUrl }}
        catalogInfoPath: "/catalog-info.yaml"

push a directory to an existing repository

I'm trying to build a component that will create a repository and push a new directory to an existing repository using one template.
From my researching, I understand that I have to create
Steps:

  • fetch skeleton1 to create a repository.
  • fetch skeleton2 to push it into an exiting repository called test inside a directory called projects.
  • publish the repository in group called team1.
  • publish the second skeleton in group called team2.

No integration for host gitlab.com

I am using the create-react-app template sample on my backstage local. I have integration defined in my app-config.yaml file

integrations:
  gitlab:
    - host: gitlab.sample.com
      apiBaseUrl: https://gitlab.sample.com/api/v4
      token:
        $env: GITLAB_TOKEN

Everything seems to be going okay, up until I get to the publishing task. Not sure if am entering the correct Owner. I am entering as my user, mbojorq12, and the repository name as reactTeamplate. Not sure how specific it would have to be. But I am getting the below integration error. Wondering if I need to add the integration within the template.yaml file

[1](http://localhost:3000/create/tasks/f47a9285-ba18-45b3-b427-426aad2f63be#line-1)2022-10-20T20:30:38.000Z Beginning step Publish
[2](http://localhost:3000/create/tasks/f47a9285-ba18-45b3-b427-426aad2f63be#line-2)2022-10-20T20:30:38.000Z InputError: No integration for host gitlab.bankofthewest.com

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.