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

Suggestion: update the build documentation and add automated builds to keep an eye on it #35

Closed
gigafone opened this issue Jan 12, 2016 · 2 comments

Comments

@gigafone
Copy link

I've found that the Building Esper documentation could be improved. When a project doesn't easily build and the documentation doesn't help, it leads to a bad developer experience.

I'm working my way through getting Esper's project-root maven build to work. As a minimal starting point, this is what I'm currently using:

mvn -DskipTests -Dgpg.skip=true install

I'd suggest this be added to the Esper documentation.

Also, I found in #34 that the build did not succeed for the current master.

Perhaps this situation could be improved by adding an automated build?

gigafone pushed a commit to gigafone/esper that referenced this issue Jan 13, 2016
@gigafone
Copy link
Author

One commit to help move this issue forward is here: gigafone@9f2eaf0

There is more to do after this. I recommend:

  • Test the build -- by hand -- on a fresh machine, from the perspective of an outside (e.g. non EsperTech) contributor. (To be clear, this is what I'm doing.) I'm asking that someone from EsperTech please do the same, because I think it will reveal bugs in the process (the ones I'm chasing down).
  • Setup automated builds. The idea here is to catch mistakes earlier -- such as the UTF-8 bug I found. I'm asking that someone from EsperTech set this up, because only the project owners have that permission. CircleCI, for example, offers free CI builds for open source projects.

@bernhardttom
Copy link
Contributor

updated "building" page at http://espertech.com/esper/building.php

We will look at why builds can fail in other environments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants