https://github.com/ergomake/ergomake

Preview environments on every pull request, for any stack.
https://github.com/ergomake/ergomake

devops ephemeral-environments infrastructure preview-environment previews staging

Last synced: 3 months ago
JSON representation

Preview environments on every pull request, for any stack.

• Host: GitHub
• URL: https://github.com/ergomake/ergomake
• Owner: briefercloud
• License: gpl-3.0
• Archived: true
• Created: 2023-06-24T21:59:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-26T16:54:17.000Z (11 months ago)
• Last Synced: 2024-05-19T18:15:45.626Z (6 months ago)
• Topics: devops, ephemeral-environments, infrastructure, preview-environment, previews, staging
• Language: Go
• Homepage: https://ergomake.dev
• Size: 2.14 MB
• Stars: 176
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
This project is not actively maintained anymore. Ergomake is now Briefer.




  

  

    

    

    

    

  





  Documentation |

  Website





  Preview environments on every pull-request, for any stack.





  

    

  

  

    

  

  

    

  



## What is Ergomake

Every time you open a PR, Ergomake spins-up your entire application and sends you a preview link.

Anything that you can run in a container, you can run in Ergomake. Our previews may include your back-end, databases, and queues, for example.

Ergomake also supports multi-repo projects.



  



## Getting Started

> You can see the complete documentation [here](https://docs.ergomake.dev/docs/intro).

1. [Log into Ergomake](https://app.ergomake.dev).

2. Select the desired organization and click the "Add Repo" button.

3. During the installation process, you'll be prompted to give it access to the repository for which you want to generate previews.

    **Make sure to select all the repositories you need**.

    > ⚠️ Ergomake can't generate previews if it doesn't have access to a repository.

4. Create a `docker-compose.yml` file in your repository's `.ergomake` folder, which should be in the repository's root.

    Ergomake will use this file to generate preview environments.

    ```yml

    # Here's an example docker-compose.yml file

    version: "3.8"

    services:

      # On pull requests, Ergomake can build your own images

      web:

        build: ..

        ports:

          - "8080:8080"

      # You can build a second repository by referencing a folder with

      # the desired repository name in a path *outside* your current repository.

      api:

        build: ../../my-backend-repo

        ports:

          - "3001:3001"

      database:

        image: mongo

        environment:

          MONGODB_INITDB_ROOT_USERNAME: username

          MONGODB_INITDB_ROOT_PASSWORD: password

    ```

5. Open a pull-request and wait for the Ergomake Bot's comment.

    That comment contains a link to all the applications running within your preview environment.

## Issues & Support

You can find Ergomake's users and maintainers in [GitHub Discussions](https://github.com/ergomake/ergomake/discussions). There you can ask how to set up Ergomake, ask us about the roadmap, and discuss any other related topics.

You can also reach us directly (and more quickly) in our [Discord server](https://discord.gg/daGzchUGDt).

## Other channels

- [Issue Tracker](https://github.com/ergomake/ergomake/issues)

- [Twitter](https://twitter.com/GetErgomake)

- [LinkedIn](https://www.linkedin.com/company/ergomake)

- [Ergomake Blog](https://ergomake.dev/blog)

## License

Licensed under the [GNU GPLv3 License](https://github.com/ergomake/ergomake/blob/main/LICENSE).