You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/08/27 17:28:00 UTC

[jira] [Commented] (METRON-1752) Prevent package.lock from changing during build

    [ https://issues.apache.org/jira/browse/METRON-1752?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16593990#comment-16593990 ] 

ASF GitHub Bot commented on METRON-1752:
----------------------------------------

GitHub user sardell opened a pull request:

    https://github.com/apache/metron/pull/1177

    METRON-1752: Prevent package.lock from changing during build

    ## Contributor Comments
    This PR updates the build script to use `npm ci` instead of `npm install`. The former command installs exactly what is in a project's package-lock.json file, whereas the later will reference package.json and update the lock file. Besides causing confusion with an unexpected file change, `npm install` had the potential to install different package versions of dependencies in different environments depending on when the install was last done. 
    
    ### Changes Included
    * Update pom.xml files in both the alerts and management ui to use `npm ci` instead of `npm install`.
    * Add a package-lock.json file to the management ui. There were no new dependencies added, just a locked version of dependencies that already existed in the project. This was done because the new command relies on reading the lock file to install exact versions of dependencies.
    
    
    ## Pull Request Checklist
    
    Thank you for submitting a contribution to Apache Metron.  
    Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.  
    Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.  
    
    
    In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
    
    ### For all changes:
    - [ ] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
    - [ ] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    - [ ] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    
    ### For code changes:
    - [ ] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
    - [ ] Have you included steps or a guide to how the change may be verified and tested manually?
    - [ ] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
      ```
      mvn -q clean integration-test install && dev-utilities/build-utils/verify_licenses.sh 
      ```
    
    - [ ] Have you written or updated unit tests and or integration tests to verify your changes?
    - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
    - [ ] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
    
    ### For documentation related changes:
    - [ ] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
    
      ```
      cd site-book
      mvn site
      ```
    
    #### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
    It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/sardell/metron METRON-1752

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/metron/pull/1177.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #1177
    
----
commit bf03de93441efd4afa24f351b470140cb9058b6b
Author: Shane Ardell <sa...@...>
Date:   2018-08-27T17:18:56Z

    update build to use npm ci

commit 6fd23f4f092a2ba02a912f4a71cd57abbf4d7d14
Author: Shane Ardell <sa...@...>
Date:   2018-08-27T17:19:28Z

    add lock file to management ui

----


> Prevent package.lock from changing during build
> -----------------------------------------------
>
>                 Key: METRON-1752
>                 URL: https://issues.apache.org/jira/browse/METRON-1752
>             Project: Metron
>          Issue Type: Bug
>            Reporter: Shane Ardell
>            Priority: Minor
>
> As referenced in this mail list discussion, the package-lock.json file in metron-alerts updates whenever we run a maven build: https://lists.apache.org/thread.html/d0da3647f2955b4257c3eb0d89235779aed64a58097b416a18de6cd9@%3Cdev.metron.apache.org%3E
> The fix for this was originally included in [PR #1096, which upgrades the Angular version used in the alerts ui|https://github.com/apache/metron/pull/1096], but as mentioned in the comments, it would be best to fix this bug in a separate issue in order to simplify its inclusion in the next release.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)