Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Procfile and buildpack-run.sh #47

Merged
merged 3 commits into from Nov 11, 2018
Merged

Adding Procfile and buildpack-run.sh #47

merged 3 commits into from Nov 11, 2018

Conversation

Macleykun
Copy link
Contributor

@Macleykun Macleykun commented Nov 11, 2018

This pull request adds the following:

  • Procfile: essential to tell the dyno (this is what runs the application) how to exactly start/run the application.
  • buildpack-run.sh: used in this buildpack: https://github.com/weibeld/heroku-buildpack-run what enables the user to define some commands before the next buildpack. For this build i used this to:
  • Clone the repository avaire.
  • Copy the .git folder one level up.
  • Copy the config.yml to the avaire.jar file. So it can be read.
  • Delete the avaire/ folder. As this cloned one is no longer needed.

What will it do?

As of now, users can now fork avaire's repo. And edit the config.yml to their liking. When they add the correct buildpacks their build succeeds and will be running.

What it won't do?

It won't have any effect to how avaire is running now. The files are only used if you prefer hosting in Heroku.
The files don't contain any template (app.json), and therefore the user has to add the following themselfs in their heroku app:

Buildpacks: (The order matters!)

Enviroment variables:

  • GRADLE_TASK build

What is left to do?

Avaire could/should use enviroment variables too instead of using the config.yml. This way, users don't expose their bot token/clientid/etc to the public. This way also enables users to quicker change these keys too. And finnaly, some configurations are automatically done for the user. Like the JAWSDB_URL enviroment variable, that is automatically set, when the mysql add-on is added.

The wrapper.jar is needed too, but this will be already added by the maintainer himself.

If you have any question regrading the pull, please feel free to ask :-)

Refs:
https://devcenter.heroku.com/articles/procfile
https://github.com/weibeld/heroku-buildpack-run

This pull request adds the following:
Procfile: essential to tell the dyno (this is what runs the application) how to exactly start/run the application.
buildpack-run.sh: used in this buildpack: https://github.com/weibeld/heroku-buildpack-run what enables the user to define some commands before the next buildpack. For this build i used this to:
Clone the repository avaire.
Copy the .git folder one level up.
Copy the config.yml to the avaire.jar file. So it can be read.
Delete the avaire/ folder. As this cloned one is no longer needed.

What will it do?
As of now, users can now fork avaire's repo. And edit the config.yml to their liking. When they add the correct buildpacks their build succeeds and will be running.
What it won't do?
It won't have any effect to how avaire is running now. The files are only used if you prefer hosting in Heroku.
The files don't contain any template (app.json), and therefore the user has to add the following themselfs in their heroku app:
Buildpacks: (The order matters!)
https://github.com/weibeld/heroku-buildpack-run
heroku/gradle
Enviroment variables:
GRADLE_TASK build

What is left to do?
Avaire could/should use enviroment variables too instead of using the config.yml. This way, users don't expose their bot token/clientid/etc to the public. This way also enables users to quicker change these keys too. And finnaly, some configurations are automatically done for the user. Like the JAWSDB_URL enviroment variable, that is automatically set, when the mysql add-on is added.

If you have any question regrading the pull, please feel free to ask :-)

Refs:
https://devcenter.heroku.com/articles/procfile
https://github.com/weibeld/heroku-buildpack-run
buildpack-run.sh Outdated Show resolved Hide resolved
Yes.
@Senither Senither merged commit e71abea into avaire:master Nov 11, 2018
@Macleykun Macleykun deleted the patch-1 branch November 11, 2018 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants