├── src
    ├── main
    │   ├── resources
    │   │   └── buildNumber.properties
    │   ├── java
    │   │   └── com
    │   │   │   └── jayway
    │   │   │       └── buildnumber
    │   │   │           ├── SpringJavaConfig.java
    │   │   │           ├── BuildNumberController.java
    │   │   │           └── PropertiesFileReader.java
    │   └── webapp
    │   │   ├── index.html
    │   │   └── WEB-INF
    │   │       └── web.xml
    └── test
    │   └── java
    │       └── com
    │           └── jayway
    │               └── buildnumber
    │                   └── PropertiesFileReaderTest.java
├── .gitignore
├── README.md
└── pom.xml


/src/main/resources/buildNumber.properties:
--------------------------------------------------------------------------------
1 | git-sha-1=${buildNumber}


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Maven
 2 | target/
 3 | 
 4 | # IntelliJ
 5 | /.idea
 6 | *.iml
 7 | *.iws
 8 | *.ipr
 9 | 
10 | # Mac OS X
11 | .DS_Store


--------------------------------------------------------------------------------
/src/test/java/com/jayway/buildnumber/PropertiesFileReaderTest.java:
--------------------------------------------------------------------------------
 1 | package com.jayway.buildnumber;
 2 | 
 3 | import org.junit.Test;
 4 | 
 5 | import static org.junit.Assert.assertFalse;
 6 | 
 7 | 
 8 | public class PropertiesFileReaderTest {
 9 | 
10 |     @Test
11 |     public void shouldGetGitSha1() {
12 |         String gitSha1 = PropertiesFileReader.getGitSha1();
13 | 
14 |         assertFalse(gitSha1.isEmpty());
15 |     }
16 | }
17 | 


--------------------------------------------------------------------------------
/src/main/java/com/jayway/buildnumber/SpringJavaConfig.java:
--------------------------------------------------------------------------------
 1 | package com.jayway.buildnumber;
 2 | 
 3 | import org.springframework.context.annotation.Bean;
 4 | import org.springframework.context.annotation.Configuration;
 5 | import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 6 | 
 7 | /**
 8 |  * Spring Java configuration used for this application.
 9 |  *
10 |  * @author Mattias Severson, Jayway
11 |  */
12 | @Configuration
13 | @EnableWebMvc
14 | public class SpringJavaConfig {
15 | 
16 |     /**
17 |      * Creates the build number controller.
18 |      * @return A {@link BuildNumberController}.
19 |      */
20 |     @Bean
21 |     public BuildNumberController buildNumberController() {
22 |         return new BuildNumberController();
23 |     }
24 | 
25 | }
26 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ## Git SHA-1 Demo
 2 | 
 3 | There are several way in which a Java project can publish its current Git SHA1:
 4 | 
 5 | * As an entry in the manifest file
 6 | * As a property in a properties file
 7 | * As a Java method call
 8 | * As a specific resource in a web service
 9 | * As a part of the DOM (e.g. as a html comment in the index.html file) in a web project
10 | 
11 | For more information, read the blog post at [http://blog.jayway.com/2012/04/07/continuous-deployment-versioning-and-git/]
12 | (http://blog.jayway.com/2012/04/07/continuous-deployment-versioning-and-git/)
13 | 
14 | 
15 | ## Getting started
16 | 
17 | Open a terminal and execute the following steps:
18 | 
19 | 1. Clone the project
20 | 
21 |         git clone git://github.com/matsev/git-build-number.git
22 | 
23 | 2. Change directory
24 | 
25 |         cd git-build-number
26 | 
27 | 3. Execute the project as a web app
28 | 
29 |         mvn jetty:run-war
30 | 
31 | 4. Browse to [http://localhost:8080/](http://localhost:8080/)


--------------------------------------------------------------------------------
/src/main/java/com/jayway/buildnumber/BuildNumberController.java:
--------------------------------------------------------------------------------
 1 | package com.jayway.buildnumber;
 2 | 
 3 | import org.springframework.http.MediaType;
 4 | import org.springframework.stereotype.Controller;
 5 | import org.springframework.web.bind.annotation.RequestMapping;
 6 | import org.springframework.web.bind.annotation.ResponseBody;
 7 | 
 8 | import java.util.Collections;
 9 | import java.util.Map;
10 | 
11 | /**
12 |  * A simple Spring controller that publishes the build number information.
13 |  *
14 |  * @author Mattias Severson, Jayway
15 |  */
16 | @Controller
17 | public class BuildNumberController {
18 | 
19 |     /**
20 |      * Gets the Git SHA-1 and returns it as a JSON object.
21 |      * @return A JSON object with the Git SHA-1 of the build.
22 |      */
23 |     @RequestMapping(value = "/git-sha-1", produces = MediaType.APPLICATION_JSON_VALUE)
24 |     @ResponseBody
25 |     public Map<String, String> getGitSha1() {
26 |         String gitSha1 = PropertiesFileReader.getGitSha1();
27 |         return Collections.singletonMap("git-sha-1", gitSha1);
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/main/webapp/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html>
 3 | 
 4 | <head>
 5 |     <meta charset="UTF-8">
 6 |     <title>Git SHA-1 Demo</title>
 7 | </head>
 8 | 
 9 | <body>
10 | 
11 | <h1>Git SHA-1 Demo</h1>
12 | 
13 | <p>
14 |     A demo of how a Git SHA-1 can be embedded in a project:
15 | 
16 |     <ul>
17 |         <li>Added to the DOM: <button onclick="alert('Git SHA-1: ${buildNumber}')">Git SHA-1</button></li>
18 |         <li>View the source of this page to see it added to the DOM as a html comment at the bottom of this page</li>
19 |         <li>In the <i>buildNumber.properties</i> file (look in the <i>WEB-INF/classes</i> folder in the generated .war file)</li>
20 |         <li>As an ordinary Java method call to the <code>PropertyReader.getGitSha1()</code></li>
21 |         <li>As a JSON response from the server: <a href="../build-number/git-sha-1">/build-number/git-sha-1</a></li>
22 |         <li>As an entry in the <i>MANIFEST.MF</i> (look in the <i>META-INF</i> folder in the generated .war file)</li>
23 |     </ul>
24 | 
25 |     For more information, read the blog post at <a href="http://blog.jayway.com/2012/04/07/continuous-deployment-versioning-and-git">
26 |         http://blog.jayway.com/2012/04/07/continuous-deployment-versioning-and-git</a>
27 | 
28 |     <!-- Git SHA-1: ${buildNumber} -->
29 | 
30 | </body>
31 | 
32 | </html>


--------------------------------------------------------------------------------
/src/main/webapp/WEB-INF/web.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <web-app xmlns="http://java.sun.com/xml/ns/javaee"
 3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |          xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
 5 |          version="3.0">
 6 | 
 7 |     <listener>
 8 |         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
 9 |     </listener>
10 | 
11 |     <context-param>
12 |         <param-name>contextClass</param-name>
13 |         <param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
14 |     </context-param>
15 | 
16 |     <context-param>
17 |         <param-name>contextConfigLocation</param-name>
18 |         <param-value>com.jayway.buildnumber.SpringJavaConfig</param-value>
19 |     </context-param>
20 | 
21 |     <servlet>
22 |         <servlet-name>dispatcher</servlet-name>
23 |         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
24 |         <init-param>
25 |             <param-name>contextClass</param-name>
26 |             <param-value>
27 |                 org.springframework.web.context.support.AnnotationConfigWebApplicationContext
28 |             </param-value>
29 |         </init-param>
30 |         <load-on-startup>1</load-on-startup>
31 |     </servlet>
32 | 
33 |     <servlet-mapping>
34 |         <servlet-name>dispatcher</servlet-name>
35 |         <url-pattern>/build-number/*</url-pattern>
36 |     </servlet-mapping>
37 | 
38 |     <welcome-file-list>
39 |         <welcome-file>index.html</welcome-file>
40 |     </welcome-file-list>
41 |     
42 | </web-app>


--------------------------------------------------------------------------------
/src/main/java/com/jayway/buildnumber/PropertiesFileReader.java:
--------------------------------------------------------------------------------
 1 | package com.jayway.buildnumber;
 2 | 
 3 | import java.io.IOException;
 4 | import java.io.InputStream;
 5 | import java.util.Properties;
 6 | 
 7 | /**
 8 |  * A property file reader that is implemented by using standard Java SE components. We could have used Spring's
 9 |  * {@link org.springframework.beans.factory.annotation.Value},
10 |  * {@link org.springframework.beans.factory.config.PlaceholderConfigurerSupport} and friends, but this approach let us
11 |  * reuse it in any Java environment.
12 |  *
13 |  * @author Mattias Severson, Jayway
14 |  */
15 | public class PropertiesFileReader {
16 | 
17 |     private static final Properties properties;
18 | 
19 |     /**
20 |      * Use a static initializer to read the properties file.
21 |      */
22 |     static {
23 |         InputStream inputStream = PropertiesFileReader.class.getResourceAsStream("/buildNumber.properties");
24 |         properties = new Properties();
25 |         try {
26 |             properties.load(inputStream);
27 |         } catch (IOException e) {
28 |             throw new RuntimeException("Failed to read properties file", e);
29 |         } finally {
30 |             if (inputStream != null) {
31 |                 try {
32 |                     inputStream.close();
33 |                 } catch (IOException e) {
34 |                     // Ignore
35 |                 }
36 |             }
37 |         }
38 |     }
39 | 
40 |     /**
41 |      * Hide default constructor.
42 |      */
43 |     private PropertiesFileReader() {}
44 | 
45 |     /**
46 |      * Gets the Git SHA-1.
47 |      * @return A {@code String} with the Git SHA-1.
48 |      */
49 |     public static String getGitSha1() {
50 |         return properties.getProperty("git-sha-1");
51 |     }
52 | }
53 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  3 |     <modelVersion>4.0.0</modelVersion>
  4 | 
  5 |     <groupId>com.jayway</groupId>
  6 |     <artifactId>git-build-number</artifactId>
  7 |     <version>0.1-SNAPSHOT</version>
  8 |     <packaging>war</packaging>
  9 | 
 10 |     <name>Git Build Number</name>
 11 | 
 12 |     <developers>
 13 |         <developer>
 14 |             <name>Mattias Severson</name>
 15 |             <url>http://blog.jayway.com/2012/04/07/continuous-deployment-versioning-and-git</url>
 16 |             <organization>Jayway</organization>
 17 |             <organizationUrl>http://www.jayway.com</organizationUrl>
 18 |         </developer>
 19 |     </developers>
 20 | 
 21 |     <scm>
 22 |         <url>https://github.com/matsev/git-build-number</url>
 23 |         <connection>scm:git:git://github.com/matsev/git-build-number.git</connection>
 24 |         <developerConnection>scm:git:ssh://git@github.com:matsev/git-build-number.git</developerConnection>
 25 |     </scm>
 26 | 
 27 |     <properties>
 28 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 29 |     </properties>
 30 | 
 31 |     <dependencies>
 32 |         <dependency>
 33 |             <groupId>org.springframework</groupId>
 34 |             <artifactId>spring-webmvc</artifactId>
 35 |             <version>3.1.2.RELEASE</version>
 36 |         </dependency>
 37 | 
 38 |         <dependency>
 39 |             <groupId>cglib</groupId>
 40 |             <artifactId>cglib</artifactId>
 41 |             <version>2.2.2</version>
 42 |         </dependency>
 43 | 
 44 |         <dependency>
 45 |             <groupId>org.codehaus.jackson</groupId>
 46 |             <artifactId>jackson-mapper-asl</artifactId>
 47 |             <version>1.9.10</version>
 48 |         </dependency>
 49 | 
 50 |         <dependency>
 51 |             <groupId>junit</groupId>
 52 |             <artifactId>junit</artifactId>
 53 |             <version>4.10</version>
 54 |             <scope>test</scope>
 55 |         </dependency>
 56 |     </dependencies>
 57 | 
 58 |     <build>
 59 |         <plugins>
 60 |             <plugin>
 61 |                 <groupId>org.apache.maven.plugins</groupId>
 62 |                 <artifactId>maven-compiler-plugin</artifactId>
 63 |                 <version>2.5.1</version>
 64 |                 <configuration>
 65 |                     <source>1.6</source>
 66 |                     <target>1.6</target>
 67 |                 </configuration>
 68 |             </plugin>
 69 | 
 70 |             <plugin>
 71 |                 <groupId>org.codehaus.mojo</groupId>
 72 |                 <artifactId>buildnumber-maven-plugin</artifactId>
 73 |                 <version>1.1</version>
 74 |                 <executions>
 75 |                     <execution>
 76 |                         <phase>validate</phase>
 77 |                         <goals>
 78 |                             <goal>create</goal>
 79 |                         </goals>
 80 |                     </execution>
 81 |                 </executions>
 82 |             </plugin>
 83 | 
 84 |             <plugin>
 85 |                 <groupId>org.apache.maven.plugins</groupId>
 86 |                 <artifactId>maven-war-plugin</artifactId>
 87 |                 <version>2.3</version>
 88 |                 <configuration>
 89 |                     <archive>
 90 |                         <manifest>
 91 |                             <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
 92 |                         </manifest>
 93 |                         <manifestEntries>
 94 |                             <!-- Adds ${buildNumber} as an entry in the manifest file -->
 95 |                             <Git-SHA-1>${buildNumber}</Git-SHA-1>
 96 |                         </manifestEntries>
 97 |                     </archive>
 98 |                     <webResources>
 99 |                         <webResource>
100 |                             <!-- Adds ${buildNumber} to index.html -->
101 |                             <directory>${basedir}/src/main/webapp</directory>
102 |                             <filtering>true</filtering>
103 |                         </webResource>
104 |                     </webResources>
105 |                 </configuration>
106 |             </plugin>
107 | 
108 |             <plugin>
109 |                 <groupId>org.mortbay.jetty</groupId>
110 |                 <artifactId>jetty-maven-plugin</artifactId>
111 |                 <version>8.1.4.v20120524</version>
112 |                 <configuration>
113 |                     <stopKey>foo</stopKey>
114 |                     <stopPort>9999</stopPort>
115 |                     <scanIntervalSeconds>5</scanIntervalSeconds>
116 |                 </configuration>
117 |             </plugin>
118 |         </plugins>
119 | 
120 |         <resources>
121 |             <resource>
122 |                 <!-- Adds ${buildNumber} to buildNumber.properties -->
123 |                 <directory>${basedir}/src/main/resources</directory>
124 |                 <filtering>true</filtering>
125 |             </resource>
126 |         </resources>
127 |     </build>
128 | </project>
129 | 


--------------------------------------------------------------------------------