Skip to content

How can I run the javaee-samples in 'development mode'? #3

Open

Description

@kubamarchwicki

The awestruct works with github api and javaee7-samples repository.
Is it possible to run it 'in devel mode'? I'd like to tune the asciidoc locally, before I push commit to any repo.

Or - shaving the yak from the other side - preview my Asciidoc comments before committing. I'd rather refrain from "blind commits"

Activity

  1. aslakknutsen commented on Feb 9, 2014

    @aslakknutsen
    Member

    Currently you need to delete _tmp/datacahce/* pr run when you do changes.

    awestuct -d should keep it a live at least to view it in the browser.

  2. kubamarchwicki commented on Mar 9, 2014

    @kubamarchwicki
    ContributorAuthor

    Ok. I'm still in a n00b mode ;-)

    awestruct in dev mode indeed rebuilds the _tmp/datacache/javaee7-samples.yml file. However, the new file is build not based on the content of _tmp/repos/javaee7-samples/ - which in my case are modified files.

    After a bit of trial and errors what worked for me was:

    • adding new remote in _tmp/repos/javaee7-samples pointing to my fork
    • modify JavaDocs and push changes to my forked branch
    • pulling the changes from my remote to _tmp/repos/javaee7-samples
    • removing _tmp/datacache/javaee7-samples.yml
    • restarting awestruct

    Sound to me a bit workaround'ish - but I haven't found a better way to go. At least I can preview my docs before a pull request.

  3. aslakknutsen commented on Mar 9, 2014

    @aslakknutsen
    Member

    Hmm, the steps that work here:

    1. awestruct -d --force <-- inital build with force to clean up output folder
    2. view current build
    3. change source of JavaDoc comments in _tmp/repos/javaee7-samples/xxx
    4. stop awestruct
    5. rm _tmp/datacache/javaee7-samples.yml
    6. goto 1
  4. kubamarchwicki commented on Mar 9, 2014

    @kubamarchwicki
    ContributorAuthor

    Ok. awestruct picks up changes from source files (*.java) but when I'm naming and describing the module in pom.xml - the xml file doesn't get picked up. That was a bit misleading for me. Now I get it.

    The pom changes are taken directly from github API?

    I'll amend the README a bit on how to contribute :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions